HEL P.BW_INTERNAL
Analysis Web Item: Using
Parameter Modification
SAP Online Help
31.05.2010
Copyright
© Copyright 2010 SAP AG. All rights reserved.
No part of this publication may be reproduced or transmitted in any form or for any purpose
without the express permission of SAP AG. The information contained herein may be
changed without prior notice.
Some software products marketed by SAP AG and its distributors contain proprietary
software components of other software vendors.
Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft
Corporation.
IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x,
System z, System z10, System z9, z10, z9, iSeries, pSeries, xSeries, zSeries, eServer, z/VM,
z/OS, i5/OS, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM,
Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower,
PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2
Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner,
WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM
Corporation.
Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.
Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered
trademarks of Adobe Systems Incorporated in the United States and/or other countries.
Oracle is a registered trademark of Oracle Corporation.
UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group.
Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are
trademarks or registered trademarks of Citrix Systems, Inc.
HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C®, World
Wide Web Consortium, Massachusetts Institute of Technology.
Java is a registered trademark of Sun Microsystems, Inc.
JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for
technology invented and implemented by Netscape.
SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, Clear Enterprise, SAP
BusinessObjects Explorer 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
SAP France in the United States and in other countries.
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
Analysis Web Item: Using Parameter Modification
2
SAP Online Help
31.05.2010
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
Analysis Web Item: Using Parameter Modification
3
SAP Online Help
31.05.2010
Icons in Body Text
Icon
Meaning
Caution
Example
Note
Recommendation
Syntax
Additional icons are used in SAP Library documentation to help you identify different types of
information at a glance. For more information, see Help on Help
General Information
Classes and Information Classes for Business Information Warehouse on the first page of any
version of SAP Library.
Typographic Conventions
Type Style
Description
Example text
Words or characters quoted from the screen. These include field
names, screen titles, pushbuttons labels, menu names, menu paths,
and menu options.
Cross-references to other documentation.
Example text
Emphasized words or phrases in body text, graphic titles, and table
titles.
EXAMPLE TEXT
Technical names of system objects. These include report names,
program names, transaction codes, table names, and key concepts of a
programming language when they are surrounded by body text, for
example, SELECT and INCLUDE.
Example text
Output on the screen. This includes file and directory names and their
paths, messages, names of variables and parameters, source text, and
names of installation, upgrade and database tools.
Example text
Exact user entry. These are words or characters that you enter in the
system exactly as they appear in the documentation.
<Example text>
Variable user entry. Angle brackets indicate that you replace these
words and characters with appropriate entries to make entries in the
system.
EXAMPLE TEXT
Keys on the keyboard, for example, F2 or ENTER.
Analysis Web Item: Using Parameter Modification
4
SAP Online Help
31.05.2010
Analysis Web Item: Using Parameter Modification ................................................................. 6
Using Modifications............................................................................................................ 8
Examples of Modules ................................................................................................... 12
Example: Column Width Module ............................................................................... 13
Example: Negative Number Module .......................................................................... 19
Example: Document Content Module ........................................................................ 21
Example: Empty Cells as Non Input-Enabled Module ................................................ 27
Example: Own Symbols for Exception Module .......................................................... 29
Example: Format Cells Module ................................................................................. 34
Example: Fix Rows and Columns Module ................................................................. 39
Example: Display Images Module ............................................................................. 43
Example: ‘Planning’ Module ...................................................................................... 47
Example: ‘Copy and Paste’ Module ........................................................................... 50
Analysis Web Item: Using Parameter Modification
5
SAP Online Help
31.05.2010
Analysis Web Item: Using Parameter Modification
Use
If you do not want to use the default display and behavior of the Analysis Web item, you can
use the Modification parameter to change them. You can modify the table structure and the
table cells.
The Modification parameter provides modules whose use can be controlled using additional
parameters.
This function enables you to use similar options to those available in earlier releases with the
Web Design API for Tables. Unlike the Web Design API for Tables, modifications enable you
to make targeted changes to the display and behavior without any programming.
Prerequisites
The modules are the main prerequisites for making modifications to the Analysis Web item.
The modules are implemented in Java. The SAP Basis infrastructure in SAP NetWeaver 7.0
does not support any customer modifications or extensions to Java coding. Customers are
therefore not able to develop their own modules for modifications to the Analysis Web item.
SAP delivers a number of sample modules. You can use parameters to modify the display
and behavior of these modules.
Note that the modification modules use and manipulate the standard
implementation of the Analysis Web item. This may mean that specific
requirements are not met. SAP tries to eliminate any potential problems.
However, situations can occur that require the standard implementation to be
modified. This type of modification is not possible in every case.
Therefore the modules are only described as examples. The modules can be
used productively. However, you are not entitled to assistance from SAP
support.
Procedure
You use the modules as follows:
..
1. Select a module from the sample modules.
2. Specify the module in the Modification parameter of the Analysis Web item.
3. Control the display and behavior of the module by specifying the module-specific
parameters.
More information: Using Modifications [Seite 8]
Result
The table of the Analysis Web item is displayed in an individual manner using the modules.
The behavior of the table may also be different. For example, you can define commands for
table cells.
Example
For example, you can define a fixed column width or display comments in cells.
More information:
Example: Set Column Width Module [Seite 13]
Example: Document Content Module [Seite 21]
Analysis Web Item: Using Parameter Modification
6
SAP Online Help
Analysis Web Item: Using Parameter Modification
31.05.2010
7
SAP Online Help
31.05.2010
Using Modifications
Use
In Web item Analysis, modifications allow you to influence how items are displayed and how
they behave using modules.
You enter the modules using the Modification (MODIFICATION) parameter. If you are using
more than one module, follow the sequence of the modules. Changed rows are passed on to
subsequent modules for further processing.
A module is only called if it is active. The Active parameter can be used to active and
deactivate modules at runtime.
The default value for parameter Active is inactive, meaning that that module will
not be called. Activate the parameter by specifying a module.
You can specify the modules for an output format so that the change in behavior only affects
output in HTML, for example, and not output in PDF.
You can find a list of possible modules under Examples of Modules [Seite 12].
Structure
The parameters that a module can have depend on the module: The documentation for the
modules describes which parameters are supported and their meaning. The following is a
general description of the parameters.
Modification
Parameter
Description
Modification (MODIFICATION)
You can use this parameter to specify one
more modules that change the display or
behavior of Web item Analysis.
Possible values:
None (NONE)
Single Module
(MOD_SINGLE_MODULE)
Module List (MOD_MODULE_LIST)
None (NONE)
The default value is to use no modifications.
Single Module (MOD_SINGLE_MODULE)
This selection makes it possible to specify one
single module.
Module List (MOD_MODULE_LIST)
This selection makes it possible to specify a list
of single modules. The modules are called in
the specified sequence, meaning that
subsequent modules modify existing cells.
This means for example that the column widths
can be defined first, and that comments can
then be displayed in a given column.
Single Module
Parameter
Analysis Web Item: Using Parameter Modification
Description
8
SAP Online Help
31.05.2010
Alias (MOD_ALIAS)
The Alias parameter makes it possible to enter
a name. The name is displayed in the Web
item parameters and simplifies identification of
a module. The alias is particularly important for
the Set Status of Module [Extern] command if
several modules are being used.
Active (ACTIVE)
The Active parameter defines whether a
module is active or not. If it is not active, the
table is not modified. You can use this
parameter and the Set Status of Module
[Extern] command to activate or deactivate a
modification at runtime.
Formats (MOD_TARGETS)
You use this parameter to define the formats
for which the module is called.
All (ALL)
Selections
(MOD_CLIENT_SELECTION)
If you choose Selections, all formats are
displayed (HTML, PDF or CSV, for example).
Each format can be activated individually. This
means that a modification can only be used in
certain formats.
Type (MOD_SELECT)
This parameter always has the value Generic
Module (MOD_GENERIC_MODULE). The
details of this parameter are described below.
Generic Module
Parameter
Description
Name of the Implementation
(MOD_REFERENCE)
You use this parameter to specify the technical
name of the module.
You can find a list of possible values under
Examples of Modules [Seite 12].
Parameter List (MOD_PARAMETER_LIST)
The parameter list contains one or more
parameters (PARAMETER). The parameters
that can be used depends on the chosen
module: The parameters are generic and can
be used flexibly. Selecting the type makes
specific input help possible. The details for a
parameter are described below.
Parameter
Parameter
Description
Name/Expression (MOD_PARAM_NAME)
You use this parameter to specify the technical
name of a parameter.
You can find the possible values in the
documentation for the individual modules. As
well as technical names, modules can support
simple expressions.
Analysis Web Item: Using Parameter Modification
9
SAP Online Help
Value (MOD_PARAM_VALUE)
31.05.2010
The value of a parameter has a certain type.
Depending on this type, a value can be
specified.
The following types are supported:
None (NONE)
String (STRING)
Boolean (BOOLEAN)
Integer (INTEGER)
Image (IMAGE)
Action (ACTION)
Data Provider
(DATA_PROVIDER_REF)
Characteristic (CHARACTERISTIC)
Characteristic Value
(CHARACTERISTIC_MEMBER)
Structure (STRUCTURE)
Structure Value
(STRUCTURE_MEMBER)
Attribute Name
(INFO_OBJECT_ATTRIBUTE)
Data Cell (DATA_CELL)
Array (MOD_VALUE_ARRAY)
Selecting a type makes specific input help
possible for each type.
If Action is selected, the command wizard
starts. If Data Provider is selected, all data
providers in the Web template are displayed.
In some cases, the generic input
help does not provide the
required values. Whenever this
happens, you need to enter the
technical name manually. You
can use Query Designer to find
the technical names of structures,
structural components and so on.
Placeholder List
(MOD_PLACEHOLDER_LIST)
With some modules, it is necessary to specify
more than one value. You can use the
placeholder list to do this.
The Name/Expression parameter can contain
placeholders that are replaced with the values
in the placeholder list.
The values in the placeholder list also have a
type. The available types are described under
the Value parameter (MOD_PARAM_VALUE).
Analysis Web Item: Using Parameter Modification
10
SAP Online Help
Analysis Web Item: Using Parameter Modification
31.05.2010
11
SAP Online Help
31.05.2010
Examples of Modules
This section contains a list with descriptions of the modules that you can use to personalize
the display and behavior of the Analysis Web item.
Column Width module
You use this module to define the width of individual columns in the Analysis Web item.
More information: Example: Column Width Module [Seite 13]
Negative Number module
You use this module to display negative numbers in a column or in the entire table in red.
More information: Example: Negative Number Module [Seite 19]
Document Content module
You use this module to display document content in a cell in the Analysis Web item.
More information: Example: Document Content Module [Seite 21]
Empty Cells as Non Input-Enabled module
You can use this module to make input-enabled cells non input-enabled.
More information: Example: Empty Cells as Non Input-Enabled Module [Seite 27]
Analysis Web Item: Using Parameter Modification
12
SAP Online Help
31.05.2010
Example: Column Width Module
Definition
The Column Width module (com.sap.ip.bi.rig.ColumnWidth) enables the
definition of the column width in the Analysis Web item. There are several possibilities for
specifying the columns:
Default width
Default width for fixed columns
Default width for specific index
Default width for specific characteristic
Default width for specific characteristic value
Default width for specific attribute
Default width for specific structure member (key figure or characteristic value)
The technical name of the implementation is com.sap.ip.bi.rig.ColumnWidth.
Other modules (e.g. documentation contents) can also have the
parameter Column (COLUMN) or Row (ROW). The possibilities
available here for entering a column are the same as for the
module Set Column Width. Note that the value might be Boolean
rather than an integer.
All columns that are not explicitly specified have the default width.
If you do not specify a default width, all columns that are not
explicitly specified have the width 0. This means that they are not
visible.
The column widths for a specific characteristic, attribute, or structure value overwrite the width
for a specific index and the default widths. An index width overwrites the default widths.
If you specify multiple columns, you have to change the names of the parameters. The
COLUMN parameter name must be different for each column. You must therefore add a
number to the names. There are the following supported ways of doing this:
COLUMN[<number>]
COLUMN_<number>
Make sure that the module is activated. If not, the column widths do not change.
Example
<bi:ANALYSIS_ITEM name="ANALYSIS_ITEM_1" designwidth="400" designheight="200" >
<bi:DATA_PROVIDER_REF value="DP_1" />
<bi:MODIFICATION type="CHOICE" value="MOD_SINGLE_MODULE" >
<bi:MOD_SINGLE_MODULE type="COMPOSITE" >
<bi:ACTIVE value="X" />
<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >
<bi:MOD_GENERIC_MODULE type="COMPOSITE" >
<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.ColumnWidth" />
<bi:MOD_PARAMETER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAMETER type="COMPOSITE" index="1" >
... (add parameter here, see below for details)
Analysis Web Item: Using Parameter Modification
13
SAP Online Help
31.05.2010
</bi:MOD_PARAMETER>
</bi:MOD_PARAMETER_LIST>
</bi:MOD_GENERIC_MODULE>
</bi:MOD_SELECT>
</bi:MOD_SINGLE_MODULE>
</bi:MODIFICATION>
</bi:ANALYSIS_ITEM>
The following section describes the various options offered in this module. The options are
specified as parameters in the parameter list (MOD_PARAMETER_LIST). A parameter is
made up of the following elements:
Name/Expression
(MOD_PARAM_NAME)
Value (MOD_PARAM_VALUE)
Placeholder List (MOD_PLACEHOLDER_LIST)
If the Placeholder List parameter is not specified, you can ignore this parameter.
Default width
The default width is important because it is used for all non-specified columns. If you do not
specify a default width, all non-specified columns are set to 0, which means that they are not
visible.
Default width
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN[*]
Default column
Value
(MOD_PARAM_VALUE)
Integer
COLUMN_DEFAULT
Width in pixels
Example for default width of 50
<bi:MOD_PARAM_NAME value="COLUMN_DEFAULT" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="50" />
</bi:MOD_PARAM_VALUE>
Default width for fixed columns
The default width for fixed columns is used for characteristic and key figure columns in the
drilldown.
Default width for fixed columns
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN_FIX
Default column
COLUMN_FIX[*]
COLUMN_FIX_DEFAULT
Value
(MOD_PARAM_VALUE)
Integer
Width in pixels
Default width for specific index
The column is identified by the specified index. The width of the specified column is set
independently of the current navigational state. If the navigational state changes, the content
of the specified column might relate to a different characteristic or key figure.
Default width for specific index
Analysis Web Item: Using Parameter Modification
14
SAP Online Help
31.05.2010
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN[<index>]
<Index> is the column. The
first column has index 1.
Value
(MOD_PARAM_VALUE)
Integer
Width in pixels
Placeholder List
(MOD_PLACEHOLDER_LIST)
Blank
Leave Placeholder List blank.
COLUMN_<index>
Example for column width of 100 for column with index 5 and index 6
<<bi:MOD_PARAM_NAME value="COLUMN[5]" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PARAM_NAME value="COLUMN[6]" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
Example with a different syntax
<bi:MOD_PARAM_NAME value="COLUMN_5" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PARAM_NAME value="COLUMN_6" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
Alternative specification of index using placeholder list
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN[<number>]
<number> is the sequential
number.
Value
(MOD_PARAM_VALUE)
Integer
Width in pixels
Placeholder List
(MOD_PLACEHOLDER_LIST)
Type = integer, value =
<index>
<Index> is the column. The
first column has index 1.
COLUMN_< number >
Example for column width of 100 for column with index 5 and index 6
Note the parameter COLUMN_... in place of the index is a continuous number.
<bi:MOD_PARAM_NAME value="COLUMN_1" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="5" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
<bi:MOD_PARAM_NAME value="COLUMN_2" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="6" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Analysis Web Item: Using Parameter Modification
15
SAP Online Help
31.05.2010
Default width for specific characteristic
The column is determined by the specification of a characteristic. The column with the
specified characteristic is always modified in line with the specified width. This is independent
of the navigational state.
Default width for specific characteristic
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN[<number>]
<number> is the sequential
number.
Value
(MOD_PARAM_VALUE)
Integer
Width in pixels
Placeholder List
(MOD_PLACEHOLDER_LIST)
Type = characteristic, value =
<characteristic>
<characteristic> is the
technical name of the
characteristic.
COLUMN_< number >
Example for column width of 200 for product characteristic (0D_PH2)
<bi:MOD_PARAM_NAME value="COLUMN_1" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="200" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="CHARACTERISTIC" >
<bi:CHARACTERISTIC value="0D_PH2" text="0D_PH2" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Default width for specific characteristic value
The column is determined by the specification of a characteristic with a characteristic value.
The column with the specified characteristic value is always modified in line with the specified
width. This is independent of the navigational state.
Default width for specific characteristic value
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN[<number>]
<number> is the sequential
number.
Value
(MOD_PARAM_VALUE)
Integer
Width in pixels
Placeholder List
(MOD_PLACEHOLDER_LIST)
Types Characteristic Value
and Value consisting of
<characteristic> and <value>
<characteristic> is the
technical name of the
characteristic and <value> is
the technical characteristic
value
COLUMN_< number >
Example for column width of 200 for characteristic value PDS12 of the characteristic
product (0D_PH2)
<bi:MOD_PARAM_NAME value="COLUMN_1" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="200" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="CHARACTERISTIC_MEMBER" >
<bi:CHARACTERISTIC_MEMBER type="COMPOSITE" >
<bi:CHARACTERISTIC value="0D_PH2" text="0D_PH2" />
<bi:MEMBER_NAME value="PDS12" text="PDS12" />
</bi:CHARACTERISTIC_MEMBER>
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Analysis Web Item: Using Parameter Modification
16
SAP Online Help
31.05.2010
Default width for specific attribute
The column is determined by the specification of an attribute. The column with the specified
attribute is always modified in line with the specified width. This is independent of the
navigational state.
Default width for specific attribute
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN[<number>]
<number> is the sequential
number.
Value
(MOD_PARAM_VALUE)
Integer
Width in pixels
Placeholder List
(MOD_PLACEHOLDER_LIST)
Type = attribute, value =
<attribute>
<attribute> is the technical
name of the attribute.
COLUMN_< number >
Example for column width of 200 for price attribute (0D_PREIS)
<bi:MOD_PARAM_NAME value="COLUMN_1" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="200" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INFO_OBJECT_ATTRIBUTE" >
<bi:INFO_OBJECT_ATTRIBUTE value="0D_PREIS" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Default width for specific member
The column is determined by the specification of a structure member (key figure). The column
with the specified structure member (key figure) is always modified in line with the specified
width. This is independent of the navigational state.
A structure value is generally a key figure. However, it can also be a selection or
a formula. You must specify the structure value as a UID. You can find this UID
in the BEx Query Designer, in the properties of structure component on the
Enhanced tab page.
If you assign a technical name in the properties of the BEx Query Designer, you
can specify a technical name.
Structure value is actually a dropdown box. Press F11 to make the field inputready. You can then insert the technical name of the key figure from the query
definition.
Default width for specific member
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN[<number>]
<number> is the sequential
number.
Value
(MOD_PARAM_VALUE)
Integer
Width in pixels
Placeholder List
(MOD_PLACEHOLDER_LIST)
Type = structure member,
value = <structure member>
<structure member> is the
technical name of the structure
member (key figure).
COLUMN_< number >
Example for column width of 150 for key figure
<bi:MOD_PARAM_NAME value="column_3" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
Analysis Web Item: Using Parameter Modification
17
SAP Online Help
31.05.2010
<bi:INTEGER value="150" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="2" value="STRUCTURE_MEMBER" >
<bi:STRUCTURE_MEMBER value="45240PLO41Z7TROE321MNA46C"
text="45240PLO41Z7TROE321MNA46C" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Continuous text with automatic line breaks (optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
WRAPPING
Using this parameter, you can
specify whether the headers
are displayed as continuous
text. Line breaks are
automatically added to the
continuous text.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example: automatic line breaks in headers
<bi:MOD_PARAM_NAME value="WRAPPING" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
Continuous text for all lines (optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
ALL_ROWS_WRAPPING
Using this parameter, you can
specify whether all lines are
displayed as continuous text.
Line breaks are automatically
added to the continuous text.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Note that preparing the continuous text is very time-consuming. Only use this
parameter if you really need continuous text.
Example: automatic line breaks in all lines
<bi:MOD_PARAM_NAME value="ALL_ROWS_WRAPPING" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
Analysis Web Item: Using Parameter Modification
18
SAP Online Help
31.05.2010
Example: Negative Number Module
Definition
The Negative Number module (com.sap.ip.bi.rig.NegativeNumber) depicts
negative numbers in a column or entire table in red. Other types of formatting are not
currently supported.
The technical name of the implementation is
com.sap.ip.bi.rig.NegativeNumber.
Make sure that the module is activated. If not, negative numbers are not
formatted.
Example
<bi:ANALYSIS_ITEM name="ANALYSIS_ITEM_1" designwidth="400" designheight="200" >
<bi:DATA_PROVIDER_REF value="DP_1" />
<bi:MODIFICATION type="CHOICE" value="MOD_SINGLE_MODULE" >
<bi:MOD_SINGLE_MODULE type="COMPOSITE" >
<bi:ACTIVE value="X" />
<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >
<bi:MOD_GENERIC_MODULE type="COMPOSITE" >
<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.NegativeNumber" />
</bi:MOD_GENERIC_MODULE>
</bi:MOD_SELECT>
</bi:MOD_SINGLE_MODULE>
</bi:MODIFICATION>
</bi:ANALYSIS_ITEM>
The following section describes the various options offered in this module. The options are
specified as parameters in the parameter list (MOD_PARAMETER_LIST). A parameter
consists of a Name/Expression (MOD_PARAM_NAME), Value (MOD_PARAM_VALUE) and
Placeholder List (MOD_PLACEHOLDER_LIST). If you do not specify the Placeholder List
parameter, you can ignore this parameter.
Column (Optional)
If no columns are specified, the negative numbers are formatted in all columns.
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN
With this parameter you can
specify the column whose
negative numbers are
formatted.
The Set Column Width Module
[Seite 13] module describes
the possible options for
specifying a column as a
parameter.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example for formatted negative numbers in the column with index 3
<bi:MOD_PARAM_NAME value="COLUMN" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="3" />
Analysis Web Item: Using Parameter Modification
19
SAP Online Help
31.05.2010
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Analysis Web Item: Using Parameter Modification
20
SAP Online Help
31.05.2010
Example: Document Content Module
Definition
The Document Content module (com.sap.ip.bi.rig.DocumentContent)
enables the display of document content in a cell in the Analysis Web item. The documents
can be displayed as comments (text only), images and links.
The technical name of the implementation is
com.sap.ip.bi.rig.DocumentContent.
You require a fixed column width for the optimum display of
document content. You can use the Width parameter to set the
width of the columns with document content.
Note that only the first comment or the first image in a cell is
shown.
The parameters Action Open Document and Action Create Comment simplify user
interaction. If a document exists for a cell, a dialog box opens when you click on the cell. This
dialog box displays the document and also contains the functionality of the Web Item list of
documents. If no document exists for this cell, you can click on the cell to open a dialog box
where you can create a new comment. More information: List of Documents [Extern]
You need to set the column width for all other columns too. You can use the Column Width
module to do this.
We recommend that you specify both modules in the module list.
More information:
Example: Set Column Width Module [Seite 13]
Using Modifications [Seite 8]
Make sure that the module is activated. Otherwise, the document content will
not be displayed.
Example for Column Width and Document Content modules
<bi:ANALYSIS_ITEM name="ANALYSIS_ITEM_1" designwidth="400" designheight="200" >
<bi:DATA_PROVIDER_REF value="DP_1" />
<bi:MODIFICATION type="CHOICE" value="MOD_SINGLE_MODULE" >
<bi:MOD_MODULE_LIST type="ORDEREDLIST" >
<bi:MOD_SINGLE_MODULE type="COMPOSITE" index="1" >
<bi:ACTIVE value="X" />
<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >
<bi:MOD_GENERIC_MODULE type="COMPOSITE" >
<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.ColumnWidth" />
<bi:MOD_PARAMETER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAMETER type="COMPOSITE" index="1" >
... (add parameter here, see below for details)
</bi:MOD_PARAMETER>
</bi:MOD_PARAMETER_LIST>
</bi:MOD_GENERIC_MODULE>
</bi:MOD_SELECT>
</bi:MOD_SINGLE_MODULE>
<bi:MOD_SINGLE_MODULE type="COMPOSITE" index="2" >
<bi:ACTIVE value="X" />
<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >
Analysis Web Item: Using Parameter Modification
21
SAP Online Help
31.05.2010
<bi:MOD_GENERIC_MODULE type="COMPOSITE" >
<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.DocumentContent" />
<bi:MOD_PARAMETER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAMETER type="COMPOSITE" index="1" >
... (add parameter here, see below for details)
</bi:MOD_PARAMETER>
</bi:MOD_PARAMETER_LIST>
</bi:MOD_GENERIC_MODULE>
</bi:MOD_SELECT>
</bi:MOD_SINGLE_MODULE>
</bi:MOD_MODULE_LIST>
</bi:MODIFICATION>
</bi:ANALYSIS_ITEM>
The section below describes the options offered in this module. These options influence how
the module functions and are specified as parameters in the parameter list
(MOD_PARAMETER_LIST). A parameter is made up of the following elements:
Name/Expression
(MOD_PARAM_NAME)
Value (MOD_PARAM_VALUE)
Placeholder List (MOD_PLACEHOLDER_LIST)
If you do not specify the Placeholder List parameter, you can ignore the parameters listed
here.
Displaying Comments
You need to choose a document display that allows you to choose between displaying
comments, images or links. It is not possible to combine the display of different document
types (for example, to display comments and images).
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
DISPLAY_TEXT_PLAIN
The selected column displays
the content of comments.
Comments are unformatted
text. Only the first comment in
a cell is shown.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example
<bi:MOD_PARAM_NAME value="DISPLAY_TEXT_PLAIN" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
Displaying Images
You need to choose a document display that allows you to choose between displaying
comments, images or links. It is not possible to combine the display of different document
types (for example, to display comments and images).
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
DISPLAY_IMAGE
Any documents that are
images are displayed in the
selected column. Only the first
image in a cell is shown.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Analysis Web Item: Using Parameter Modification
22
SAP Online Help
31.05.2010
Example
<bi:MOD_PARAM_NAME value="DISPLAY_IMAGE" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
Displaying Links
You need to choose a document display that allows you to choose between displaying
comments, images or links. It is not possible to combine the display of different document
types (for example, to display comments and images).
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
DISPLAY_LINK
The documents are displayed
as links in the selected
column. All the documents of a
cell are shown as links within
the relevant cell.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example
<bi:MOD_PARAM_NAME value="DISPLAY_LINK" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
Column
You must specify a column.
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN
You use this parameter to
specify the column with the
value that you want to replace
with document content.
The Set Column Width module
describes the possible options
for specifying a column as a
parameter.
More information: Example:
Column Width Module [Seite
13]
Wert (MOD_PARAM_VALUE)
Boolean
Active
Example for displaying document content in column with index 3
<bi:MOD_PARAM_NAME value="COLUMN" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="3" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Width
It is recommended that you specify a column width because the default column width is
usually too narrow for displaying documentation contents.
Parameter
Value
Analysis Web Item: Using Parameter Modification
Description
23
SAP Online Help
31.05.2010
Name/Expression
(MOD_PARAM_NAME)
WIDTH
Width of column in which to
display document content.
Value
(MOD_PARAM_VALUE)
Integer
Width in pixels
Example for a column width of 200
<bi:MOD_PARAM_NAME value="WIDTH" />
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="200" />
</bi:MOD_PARAM_VALUE>
Height (Display of Images Only)
To display images, you need to enter the height as the system cannot calculate the size of the
images. The height of the row is automatically calculated for displaying comments and links.
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
HEIGHT
Height of row in which
document content is
displayed.
Value
(MOD_PARAM_VALUE)
Integer
Height in pixels
Example with Row Height 100
<bi:MOD_PARAM_NAME value="HEIGHT" />
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
Action: Open Document (optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
ACTION_OPEN_ON_CLICK
If a document exists for a cell,
a dialog box opens when you
click on the cell. This dialog
box displays the document
and also contains the
functionality of the Web Item
list of documents. More
information: List of Documents
[Extern]
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example for Action Document Open, if document exists
<bi:MOD_PARAM_NAME value=" ACTION_OPEN_ON_CLICK " />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
Action: Create Comment (optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
ACTION_NEW_COMMENT_ON_CLICK
If no document exists
for this cell, you can
click on the cell to open
a dialog box where you
can create a new
comment.
Analysis Web Item: Using Parameter Modification
24
SAP Online Help
Value
(MOD_PARAM_VALUE)
31.05.2010
Boolean
Active
Example for Create Action Comment, if no document exists
<bi:MOD_PARAM_NAME value="ACTION_NEW_COMMENT_ON_CLICK" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
Alignment (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
ALIGNMENT
Alignment
Value
(MOD_PARAM_VALUE)
Character string
Possible values are:
Left (LEFT)
Centered (CENTER)
Right (RIGHT)
The default value is Centered.
Example for left alignment
<bi:MOD_PARAM_NAME value="ALIGNMENT" />
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="STRING" >
<bi:STRING value="LEFT" />
</bi:MOD_PARAM_VALUE>
Heading (optional)
You can enter any text for the column heading. It is not possible to use a language-dependent
text as a parameter. You can define a language-dependent text for the query in BEx Query
Designer.
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
CAPTION
Column heading
Value
(MOD_PARAM_VALUE)
Character string
Text
Example for left alignment
<bi:MOD_PARAM_NAME value="CAPTION" />
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="STRING" >
<bi:STRING value="Comment" />
</bi:MOD_PARAM_VALUE>
Results Row (optional)
Generally it only useful to show documents for characteristic values or data cells. If you also
want to display documents in the results rows, you need to activate this parameter.
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
RESULT
Display documents in results
rows
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example for Create Action Comment, if no document exists
<bi:MOD_PARAM_NAME value="RESULT" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
Analysis Web Item: Using Parameter Modification
25
SAP Online Help
31.05.2010
</bi:MOD_PARAM_VALUE>
Maximum Length of Document Content (optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
MAX_CONTENT_LENGTH
Maximum length of document
content after which any further
content is truncated. The fact
that content is truncated is
indicated by „...“.
Value
(MOD_PARAM_VALUE)
Integer
Length in characters
Example for limit of 1000 characters
<bi:MOD_PARAM_NAME value="MAX_CONTENT_LENGTH" />
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="1000" />
</bi:MOD_PARAM_VALUE>
Correction for Character Set (optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
FONT_SIZE_OFFSET
You use this parameter to
influence the calculation of the
optimal row height.
You only require this
parameter if another character
set is used in the portal theme.
Value
(MOD_PARAM_VALUE)
Integer
Positive or negative correction
to correct the character width.
Example for larger character set with correction of 2
<bi:MOD_PARAM_NAME value="FONT_SIZE_OFFSET" />
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="2" />
</bi:MOD_PARAM_VALUE>
Analysis Web Item: Using Parameter Modification
26
SAP Online Help
31.05.2010
Example: Empty Cells as Non Input-Enabled
Module
Definition
Using the Empty Cells as Non Input-Enabled module
(com.sap.ip.bi.rig.NonInputableEmptyCells ) you can make inputenabled cells non input-enabled.
In BI Integrated planning, automatic creation of rows and/or columns can lead to cells being
created that are input enabled from a technical point of view, but for process reasons should
not be input-enabled in one or more queries. Cells like these are normally locked using data
slices, which means though that these combinations are locked against changes (including
changes by planning functions) in the entire system. If you only want the lock to apply in one
or more queries, you can override the input-enabledness of the cells in the Web Item
analysis, using the module.
The technical name of this implementation is
com.sap.ip.bi.rig.NonInputableEmptyCells.
Make sure that the module is activated. Otherwise, empty cells will remain input
enabled.
Example
<bi:ANALYSIS_ITEM name="ANALYSIS_ITEM_1" designwidth="400" designheight="200" >
<bi:DATA_PROVIDER_REF value="DP_1" />
<bi:MODIFICATION type="CHOICE" value="MOD_SINGLE_MODULE" >
<bi:MOD_SINGLE_MODULE type="COMPOSITE" >
<bi:ACTIVE value="X" />
<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >
<bi:MOD_GENERIC_MODULE type="COMPOSITE" >
<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.NonInputableEmptyCells" />
</bi:MOD_GENERIC_MODULE>
</bi:MOD_SELECT>
</bi:MOD_SINGLE_MODULE>
</bi:MODIFICATION>
</bi:ANALYSIS_ITEM>
The section below describes the options offered in this module. These options influence how
the module functions and are specified as parameters in the parameter list
(MOD_PARAMETER_LIST). A parameter is made up of the following elements:
Name/Expression
(MOD_PARAM_NAME)
Value (MOD_PARAM_VALUE)
Placeholder List (MOD_PLACEHOLDER_LIST)
If the Placeholder List parameter is not specified, you can ignore this parameter.
Column (Optional)
If no columns are specified, the negative numbers are formatted in all columns.
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN
Using this parameter you can
specify the column containing
the empty cells that you don’t
want to set to input-enabled.
The Set Column Width module
Analysis Web Item: Using Parameter Modification
27
SAP Online Help
31.05.2010
describes the possible options
for specifying a column as a
parameter.
More information: Example:
Column Width Module [Seite
13]
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example with non input-enabled empty cells in column with index 3
<bi:MOD_PARAM_NAME value="COLUMN" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="3" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Analysis Web Item: Using Parameter Modification
28
SAP Online Help
31.05.2010
Example: Own Symbols for Exception Module
Definition
The Own Symbols for Exception module
(com.sap.ip.bi.rig.ExceptionImage) enables you to display exceptions with
your own symbols or images.
You can specify your own symbols in two ways:
with three levels using the following parameters
ALERT_GOOD,
ALERT_CRITICAL
ALERT_BAD
with nine levels using the parameters ALERT_1 to ALERT_9
If you do not specify a symbol of your own for each alert level, the standard symbol is retained
for this alert level.
The way the module functions depends on the display type of the exceptions defined using
parameter Exception Display (EXCEPTION_RENDERING) in Web Item Analysis. The main
difference is the background color.
Exception Display with Background Color
If this is set to Color, the exception in the cell is displayed as the background color with text as
the standard setting. No symbols are displayed with the display type. The modules also has
parameter Display Type with Exception Display with Color
(EXCEPTION_RENDERING_COLOR). You can use this parameter to select how the
background color is combined with an symbol and/or text:
Exception Display without Background Color
If parameter Exception Display has the value Symbol (SYMBOL), Symbol and Text
(SYMBOL_TEXT) or Text and Symbol (TEXT_SYMBOL), the cells are displayed without
background color. The module just replaces the standard symbols with your own symbols.
The alignment of symbol and text is unaffected.
More information: Analysis [Extern]
The technical name of the implementation is
com.sap.ip.bi.rig.ExceptionImage.
Make sure that the module is activated. Otherwise, the symbols will not be
changed.
Example
<bi:ANALYSIS_ITEM name="ANALYSIS_ITEM_1" designwidth="400" designheight="200" >
<bi:DATA_PROVIDER_REF value="DP_1" />
<bi:MODIFICATION type="CHOICE" value="MOD_SINGLE_MODULE" >
<bi:MOD_SINGLE_MODULE type="COMPOSITE" >
<bi:ACTIVE value="X" />
<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >
<bi:MOD_GENERIC_MODULE type="COMPOSITE" >
<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.ExceptionImage" />
<bi:MOD_PARAMETER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAMETER type="COMPOSITE" index="1" >
... (add parameter here, see below for details)
</bi:MOD_PARAMETER>
Analysis Web Item: Using Parameter Modification
29
SAP Online Help
31.05.2010
</bi:MOD_PARAMETER_LIST>
</bi:MOD_GENERIC_MODULE>
</bi:MOD_SELECT>
</bi:MOD_SINGLE_MODULE>
</bi:MODIFICATION>
</bi:ANALYSIS_ITEM>
The section below describes the options offered in this module. These options influence how
the module functions and are specified as parameters in the parameter list
(MOD_PARAMETER_LIST). A parameter is made up of the following elements:
Name/Expression
(MOD_PARAM_NAME)
Value (MOD_PARAM_VALUE)
Placeholder List (MOD_PLACEHOLDER_LIST)
If you do not specify the Placeholder List parameter, you can ignore this parameter.
Symbols for Three-Level Alert Levels
Either the parameters for the three-level alert levels or the nine-level alert levels (see next
parameter) need to be specified .
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
ALERT_GOOD,
ALERT_CRITICAL,
ALERT_BAD
You can use these three
parameters to specify the URL
or path in the MIME repository
(SE80) for your own symbols.
You can use these parameters
to set symbols for the three
alert levels Good, Critical and
Bad.
Value
(MOD_PARAM_VALUE)
Image
URL or path in the MIME
Repository:
Example of a symbol from the MIME repository
<bi:MOD_PARAM_NAME value="ALERT_GOOD" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="IMAGE" >
<bi:IMAGE value="bwmimerep:///sap/bw/mime/BEx/Icons/marked_right.gif" />
</bi:MOD_PARAM_VALUE>
Symbols for Nine-Level Alert Levels
Either the parameters for the three-level alert levels (see previous parameter) or the ninelevel alert levels need to be specified
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
ALERT_1 to ALERT_9
You can use these nine
parameters to specify the URL
or path in the MIME repository
(SE80) for your own symbols.
You can use this parameter to
set symbols for all nine alert
levels.
ALERT_1 equates to
Good 1
ALERT_2 equates to
Good 2
ALERT_3 equates to
Good 3
Analysis Web Item: Using Parameter Modification
30
SAP Online Help
31.05.2010
ALERT_4 equates to
Critical 1
ALERT_5 equates to
Critical 2
ALERT_6 equates to
Critical 3
ALERT_7 equates to
Bad 1
ALERT_8 equates to
Bad 2
ALERT_9 equates to
Bad 3
Value
(MOD_PARAM_VALUE)
Image
URL or path in the MIME
Repository:
Example of a symbol from the MIME repository
<bi:MOD_PARAM_NAME value="ALERT_1" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="IMAGE" >
<bi:IMAGE value="bwmimerep:///sap/bw/mime/BEx/Icons/marked_right.gif" />
</bi:MOD_PARAM_VALUE>
Column (optional)
If no columns are specified, your own symbols are used for exceptions in all columns.
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN
You use this parameter to
specify the column whose
exceptions you want to
replace with your own
symbols.
The Set Column Width module
describes the possible options
for specifying a column as a
parameter. More information:
Example: Column Width
Module [Seite 13]
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example for displaying document content in column with index 3
<bi:MOD_PARAM_NAME value="COLUMN" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="3" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Alignment (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
ALIGNMENT
Alignment
Value
Character string
Possible values are:
Analysis Web Item: Using Parameter Modification
31
SAP Online Help
31.05.2010
(MOD_PARAM_VALUE)
•
Left (LEFT)
•
Centered (CENTER)
•
Right (RIGHT)
The default value is Centered.
Example for left alignment
<bi:MOD_PARAM_NAME value="ALIGNMENT" />
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="STRING" >
<bi:STRING value="LEFT" />
</bi:MOD_PARAM_VALUE>
Height (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
HEIGHT
Height of the row in pixels. It
might be necessary to specify
the height if the height of one
of your own symbols is greater
than the standard height of a
row.
Value
(MOD_PARAM_VALUE)
Integer
Height in pixels
Example with a height of 20 pixels
<bi:MOD_PARAM_NAME value="HEIGHT" />
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="20" />
</bi:MOD_PARAM_VALUE>
Display Type with Exception Display with Color (Optional)
Parameter Display Type with Exception Display with Color is only valid if Web Item Analysis
parameter Exception Display (EXCEPTION_RENDERING) has the value Color (COLOR).
With all other exception display types, parameter EXCEPTION_RENDERING_COLOR is
ignored.
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
EXCEPTION_RENDERING_COLOR
This parameter enables you
to decide whether to display
just the symbol or the symbol
and the text together. You
can also define whether the
symbol appears to the left of
the text or the right.
Value
(MOD_PARAM_VALUE)
Character string
The following display options
are available:
Symbol and Text
(SYMBOL_TEXT)
Text and Symbol
(TEXT_SYMBOL)
Symbol Only
(SYMBOL)
Example with the exception displayed as a symbol with background color
<bi:MOD_PARAM_NAME value="EXCEPTION_RENDERING_COLOR" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="STRING" >
<bi:STRING value="SYMBOL" />
</bi:MOD_PARAM_VALUE>
Analysis Web Item: Using Parameter Modification
32
SAP Online Help
31.05.2010
Distance Between Symbol and Content (Optional)
Parameter Distance Between Symbol and Content is only valid if Web Item Analysis
parameter Exception Display (EXCEPTION_RENDERING) has the value Color (COLOR).
With all other exception display types, parameter SEPARATOR is ignored.
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
SEPARATOR
You cam use this parameter to set
the distance in pixels between the
text and the symbol. (See parameter
EXCEPTION_RENDERING_COLOR)
Wert (MOD_PARAM_VALUE)
Integer
Number of pixels
Example with a distance of 5 pixels
<bi:MOD_PARAM_NAME value="SEPARATOR" />
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="5" />
</bi:MOD_PARAM_VALUE>
Analysis Web Item: Using Parameter Modification
33
SAP Online Help
31.05.2010
Example: Format Cells Module
Definition
The Format Cells module (com.sap.ip.bi.rig.Format) enables you to specifically
format cells in the Analysis Web Item. The following format functions are supported:
Font and background color
Bold and italic text
Horizontal and vertical alignment
As well as the formatting, it is also necessary to specify which cells should be adjusted. Cells
can be specified in three ways:
Cell type
Column
Row
These three options can be combined, for example to format a particular cell (combination of
column and row) or a specific totals row for a characteristic value (combination of cell type
Total and Row with Characteristic Value.
The cell type for a given cell can be displayed using parameter CELL_DEBUG.
This parameter allows you to specify cell types, rows and columns.
The module can be used multiple times in an Analysis Web Item to format various cells.
The technical name of the implementation is com.sap.ip.bi.rig.Format.
More information:
Using Modifications [Seite 8]
Make sure that the module is activated. Otherwise, the formatting will not be
displayed.
Example: Format Cells Types Module
<bi:ANALYSIS_ITEM name="ANALYSIS_ITEM_1" designwidth="400" designheight="200" >
<bi:DATA_PROVIDER_REF value="DP_1" />
<bi:MODIFICATION type="CHOICE" value="MOD_SINGLE_MODULE" >
<bi:MOD_SINGLE_MODULE type="COMPOSITE" >
<bi:ACTIVE value="X" />
<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >
<bi:MOD_GENERIC_MODULE type="COMPOSITE" >
<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.Format" />
<bi:MOD_PARAMETER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAMETER type="COMPOSITE" index="1" >
... (add parameter here, see below for details)
</bi:MOD_PARAMETER>
</bi:MOD_PARAMETER_LIST>
</bi:MOD_GENERIC_MODULE>
</bi:MOD_SELECT>
</bi:MOD_SINGLE_MODULE>
</bi:MODIFICATION>
</bi:ANALYSIS_ITEM>
Analysis Web Item: Using Parameter Modification
34
SAP Online Help
31.05.2010
The section below describes the options offered in this module. These options influence how
the module functions and are specified as parameters in the parameter list
(MOD_PARAMETER_LIST). A parameter is made up of the following elements:
Name/Expression
(MOD_PARAM_NAME)
Value (MOD_PARAM_VALUE)
Placeholder List (MOD_PLACEHOLDER_LIST)
If you do not specify the Placeholder List parameter, you can ignore this parameter.
Cells can be specified in three ways: cell type, column and row. You can combine these three
methods. However, at least one of these methods must be used to format cells.
Cell type
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
CELL_NONE
The cell types
here can be
selected to
format the
corresponding
cells.
Parameter
CELL_DEBUG
displays the
cell type of all
cells.
CELL_STANDARD CELL_DISABLED
CELL_READ_ONLY CELL_ALTERNATING CELL_TRANSPARENT
CELL_HEADER
CELL_TITLE CELL_LEVEL1HEADER CELL_LEVEL2HEADER
CELL_LEVEL3HEADER CELL_ALERT_9_BAD_STRONG
CELL_ALERT_8_BAD_MEDIUM
CELL_ALERT_7_BAD_LIGHTCELL_ALERT_6_CRITICAL_STRONG
CELL_ALERT_5_CRITICAL_MEDIUM
CELL_ALERT_4_CRITICAL_LIGHT CELL_ALERT_3_GOOD_LIGHT
CELL_ALERT_2_GOOD_MEDIUM
CELL_ALERT_1_GOOD_STRONG
CELL_NEGATIVE CELL_POSITIVE CELL_TOTAL
CELL_SUBTOTAL CELL_SUBTOTAL_LIGHT
CELL_GROUP_HIGHLIGHTED
CELL_GROUP_HIGHLIGHTED_LIGHT CELL_KEY_MEDIUM,
CELL_GROUP_LEVEL1 CELL_GROUP_LEVEL2
CELL_GROUP_LEVEL3 CELL_HIERARCHY_LEVEL1
CELL_HIERARCHY_LEVEL2
CELL_HIERARCHY_LEVEL3 CELL_HIERARCHY_LEVEL4
CELL_FILTER CELL_FILTERICON CELL_MARKED
CELL_SELECTED1 CELL_SELECTED2 CELL_SELECTED3
CELL_SELECTED4 CELL_SELECTED5
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example with formatting for cell type CELL_HEADER
<bi:MOD_PARAM_NAME value="CELL_HEADER" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
Column
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN
You can use this parameter to
specify the column with the
cells to be formatted.
The Set Column Width module
describes the options for
Analysis Web Item: Using Parameter Modification
35
SAP Online Help
31.05.2010
specifying a column as a
parameter.
More information:
Example: Set Column Width
Module [Seite 13]
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example with formatting in column 1 with index 3
<bi:MOD_PARAM_NAME value="COLUMN" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="3" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Row
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
ROW
You can use this parameter to
specify the row with the cells
to be formatted.
The Set Column Width module
describes the options for
specifying a row as a
parameter.
Note that parameter COLUMN
must be replaced with ROW.
More information:
Example: Set Column Width
Module [Seite 13]
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example with formatting in row with index 5
<bi:MOD_PARAM_NAME value="ROW" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="5" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Text Color (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLOR
You can use this parameter to
select the text color.
Value
(MOD_PARAM_VALUE)
Character string
The color can be specified
either as a hexadecimal value
or as a color name.
Example with dark-green text color
<bi:MOD_PARAM_NAME value="COLOR" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="STRING" >
<bi:STRING value="#008800" />
Analysis Web Item: Using Parameter Modification
36
SAP Online Help
31.05.2010
</bi:MOD_PARAM_VALUE>
Background Color (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
BACKGROUND_COLOR
You can use this parameter to
select the background color.
Value
(MOD_PARAM_VALUE)
Character string
The color can be specified
either as a hexadecimal value
or as a color name.
Example with black background
<bi:MOD_PARAM_NAME value="BACKGROUND_COLOR" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="STRING" >
<bi:STRING value="Black " />
</bi:MOD_PARAM_VALUE>
Bold Text (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
BOLD
You can use this parameter to
set bold text.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example
<bi:MOD_PARAM_NAME value="BOLD" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN">
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
Italic Text (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
ITALIC
You can use this parameter to
activate italic text.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example
<bi:MOD_PARAM_NAME value="ITALIC" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN">
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
Horizontal Alignment (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
ALIGNMENT
Horizontal Alignment
Value
(MOD_PARAM_VALUE)
Character string
Possible values are:
Left (LEFT)
Centered (CENTER)
Right (RIGHT)
The default value is Centered.
Example
<bi:MOD_PARAM_NAME value="ALIGNMENT" />
Analysis Web Item: Using Parameter Modification
37
SAP Online Help
31.05.2010
<bi:MOD_PARAM_VALUE type="CHOICE" value="STRING" >
<bi:STRING value="RIGHT" />
</bi:MOD_PARAM_VALUE>
Vertical Alignment (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
VERTICAL_ALIGNMENT
Vertical Alignment
Value
(MOD_PARAM_VALUE)
Character string
Possible values are:
Top (TOP)
Centered (CENTER)
Bottom (BOTTOM)
The default value is Centered.
Example
<bi:MOD_PARAM_NAME value="VERTICAL_ALIGNMENT" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="STRING" >
<bi:STRING value="TOP" />
</bi:MOD_PARAM_VALUE>
Display Cell Types (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
CELL_DEBUG
Parameter CELL_DEBUG
displays the cells with the
relevant cell type, column, row
and the characteristic value,
structure value or value. You
can use this parameter to
format a specific cell, column
or row.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example
<bi:MOD_PARAM_NAME value="CELL_DEBUG" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN">
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
Analysis Web Item: Using Parameter Modification
38
SAP Online Help
31.05.2010
Example: Fix Rows and Columns Module
Definition
The Fix Rows and Columns module (com.sap.ip.bi.rig.Scrolling) allows you
to fix the header rows and leading columns in Web Item Analysis.
The header rows contain the column headers. The leading columns normally contain the
characteristics.
The ideal height and width of Web Item Analysis can be specified as a value or JavaScript
variable. The JavaScript variable can be used to set the height and width in accordance with
the window size of the web browser.
We recommend configuring the settings in Web Item Analysis so
that all data rows and columns are displayed. To do this, set
parameters BLOCK_COLUMNS_SIZE and BLOCK_ROWS_SIZE
to 0.
Note that displaying a large table with fixed rows and columns
can cause performance problems both for the client and for the
server. You can therefore limit the display. You can define a limit
after which a warning message and another after which an error
message is displayed. For the error message, the table is
displayed without fixed rows and columns. Parameters Row and
Column enable you to specify fixed rows and columns, to fix just
the first column for example. If these parameters are not set, the
header rows and the leading columns are fixed. The data cells
can be moved.
The technical name of the implementation is com.sap.ip.bi.rig.Scrolling.
More information: Using Modifications [Seite 8]
Make sure that the module is activated. Otherwise, the rows and columns will
not be fixed.
Example with Fix Rows and Columns Module
<bi:ANALYSIS_ITEM name="ANALYSIS_ITEM_1" designwidth="400" designheight="200" >
<bi:DATA_PROVIDER_REF value="DP_1" />
<bi:MODIFICATION type="CHOICE" value="MOD_SINGLE_MODULE" >
<bi:MOD_SINGLE_MODULE type="COMPOSITE" >
<bi:ACTIVE value="X" />
<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >
<bi:MOD_GENERIC_MODULE type="COMPOSITE" >
<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.Scrolling" />
<bi:MOD_PARAMETER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAMETER type="COMPOSITE" index="1" >
... (add parameter here, see below for details)
</bi:MOD_PARAMETER>
</bi:MOD_PARAMETER_LIST>
</bi:MOD_GENERIC_MODULE>
</bi:MOD_SELECT>
</bi:MOD_SINGLE_MODULE>
</bi:MODIFICATION>
</bi:ANALYSIS_ITEM>
Analysis Web Item: Using Parameter Modification
39
SAP Online Help
31.05.2010
The section below describes the options offered in this module. These options influence how
the module functions and are specified as parameters in the parameter list
(MOD_PARAMETER_LIST). A parameter is made up of the following elements:
Name/Expression
(MOD_PARAM_NAME)
Value (MOD_PARAM_VALUE)
Placeholder List (MOD_PLACEHOLDER_LIST)
If you do not specify the Placeholder List parameter, you can ignore the parameters listed
here.
Width (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
WIDTH
You can use this optional
parameter to specify the ideal
width of the table. If less space
than this is available, the
columns are fixed:
Value
(MOD_PARAM_VALUE)
Character string
You can enter either a number
(300, for example) or a
JavaScript variable.
Normally, the width of the web
browser window is used
(document.body.clientWidth).
Example with width 50% of the width of the web browser window
<bi:MOD_PARAM_NAME value="WIDTH" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="STRING" >
<bi:STRING value="document.body.clientWidth / 2" />
</bi:MOD_PARAM_VALUE>
Height (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
HEIGHT
You can use this optional
parameter to specify the ideal
height of the table. If less
space than this is available,
the rows are fixed:
Value
(MOD_PARAM_VALUE)
Character string
You can enter either a number
(300, for example) or a
JavaScript variable.
Normally, the height of the
web browser window is used
(document.body.clientHeight).
Example with height of the web browser window
<bi:MOD_PARAM_NAME value="HEIGHT" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="STRING" >
<bi:STRING value="document.body.clientHeight" />
</bi:MOD_PARAM_VALUE>
Column (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
COLUMN
You can use this parameter to
specify the last fixed column.
Analysis Web Item: Using Parameter Modification
40
SAP Online Help
31.05.2010
The Set Column Width module
describes the possible options
for specifying a column as a
parameter.
More information:
Example: Set Column Width
Module [Seite 13]
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example with the column for of characteristic Product (0D_PH2) fixed
<bi:MOD_PARAM_NAME value="COLUMN" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="CHARACTERISTIC" >
<bi:CHARACTERISTIC value="0D_PH2" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Row (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
ROW
You can use this parameter to
specify the last fixed row.
The Set Column Width module
describes the possible options
for specifying a row as a
parameter.
Note that parameter COLUMN
must be replaced with ROW.
More information:
Example: Set Column Width
Module [Seite 13]
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example with rows fixed up to row with index 5
<bi:MOD_PARAM_NAME value="ROW" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="5" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Limit for Error Message (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
LIMIT_ERROR
This optional parameter
enables you to specify a limit.
If the number of rows exceeds
the limit, an error message is
displayed. The rows and
columns are not fixed.
Analysis Web Item: Using Parameter Modification
41
SAP Online Help
Wert (MOD_PARAM_VALUE)
31.05.2010
Integer
The default setting for the limit
is 10,000.
Example with error message after limit of 1,000 cells is exceeded
<bi:MOD_PARAM_NAME value="LIMIT_ERROR" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="1000" />
</bi:MOD_PARAM_VALUE>
Limit for Warning Message (Optional)
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
LIMIT_WARNING
This optional parameter
enables you to specify a limit.
If the number of rows exceeds
the limit, a warning message is
displayed. The rows and
columns are fixed until the limit
for the error message is
reached.
Value
(MOD_PARAM_VALUE)
Integer
The default setting for the limit
is 3,000.
Example with warning message after limit of 500 cells is exceeded
<bi:MOD_PARAM_NAME value="LIMIT_WARNING" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="500" />
</bi:MOD_PARAM_VALUE>
Analysis Web Item: Using Parameter Modification
42
SAP Online Help
31.05.2010
Example: Display Images Module
Definition
The Display Images module (com.sap.ip.bi.rig.DocumentContent ) enables
you to display images that are not stored in knowledge management in the portal. For
performance reasons, images can be stored on a web server if the large number of images
makes it unpractical to store them in knowledge management.
The images are embedded using URLs. The URLs are formed dynamically according to the
following formula:
<Parameter IMAGE_URL_PREFIX> <Cell Content> <Parameter IMAGE_URL_SUFFIX>
Parameter URL Prefix contains the web protocol, the host name, port and path to the images.
Parameter URL Suffix contains the file ending, for example jpg or gif.
The cell content corresponds to the file name of the image. We therefore
recommend displaying the characteristic value as a key. The key is unique,
meaning that the file names are unique too.
Example of a Composite URL
URL Prefix
Cell Content
URL Suffix
http://hostanme:1080/sap/bw/mime/customer/images/products/
PDS01
.jpg
The Display Images module and the Display Document Content module are identical. The
following list tells you which parameters are supported and which are not.
The following parameters are supported:
Column (COLUMN)
Width (WIDTH)
Height (HEIGHT)
Alignment (ALIGNMENT)
Caption (CAPTION)
Result (RESULT)
The following parameters are not supported:
Open document (ACTION_OPEN_ON_CLICK)
Create comment (ACTION_NEW_COMMENT_ON_CLICK)
Maximum length of document content (MAX_CONTENT_LENGTH)
Correction for character set (FONT_SIZE_OFFSET)
The images normally only exist for a particular characteristic.
Parameter Column (COLUMN) should therefore only be specified
for this particular characteristic.
You require a fixed column width for the optimum display of
document content. You can use the Width parameter to set the
width of the columns with document content. You need to set the
column width for all other columns too. You can use the Column
Analysis Web Item: Using Parameter Modification
43
SAP Online Help
31.05.2010
Width module to do this. We recommend that you specify both
modules in the module list.
The technical name of the implementation is com.sap.ip.bi.rig.DocumentContent.
More information:
Example: Document Content Module [Seite 21]
Example: Set Column Width Module [Seite 13]
Using Modifications [Seite 8]
Make sure that the module is activated. Otherwise, the document content will
not be displayed.
The following section describes the various options offered in this module. The options are
specified as parameters in the parameter list (MOD_PARAMETER_LIST). A parameter is
made up of the following elements:
Name/Expression
(MOD_PARAM_NAME)
Value (MOD_PARAM_VALUE)
Placeholder List (MOD_PLACEHOLDER_LIST)
If the Placeholder List parameter is not specified, you can ignore this parameter.
Displaying Images
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
DISPLAY_IMAGE_URL
The images are displayed in
the column selected. The URL
for the images is determined
dynamically from the cell
content.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example
<bi:MOD_PARAM_NAME value="DISPLAY_IMAGE_URL" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
URL Prefix
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
IMAGE_URL_PREFIX
This parameter contains the
first part of the composite
URL.
Value
(MOD_PARAM_VALUE)
Character string
Web protocol, host name, port
and path
Example with host name and path to the MIME repository as URL prefix
<bi:MOD_PARAM_NAME value="IMAGE_URL_PREFIX" />
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="STRING" >
<bi:STRING value=" http://hostanme:1080/sap/bw/mime/customer/images/products/" />
</bi:MOD_PARAM_VALUE>
Analysis Web Item: Using Parameter Modification
44
SAP Online Help
31.05.2010
URL Suffix
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
IMAGE_URL_SUFFIX
This parameter contains the
file extension from the images.
Value
(MOD_PARAM_VALUE)
Character string
File extension
Example with .jpg as URL suffix
<bi:MOD_PARAM_NAME value="IMAGE_URL_SUFFIX" />
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="STRING" >
<bi:STRING value=".jpg" />
</bi:MOD_PARAM_VALUE>
Example with Display Images Module
The example shows images from the web server
http://hostanme:1080/sap/bw/mime/customer/images/products/ with file extension .jpg. The
images are displayed in the column for characteristic Product (0D_PH2). The column has the
header “URL”. The size of the cell is fixed at 120x120 pixels.
The width of the other columns is set using the second module Set Column Width.
<bi:ANALYSIS_ITEM name="ANALYSIS_ITEM_1" designwidth="400" designheight="200" >
<bi:DATA_PROVIDER_REF value="DP_1" />
<bi:MODIFICATION type="CHOICE" value="MOD_MODULE_LIST" >
<bi:MOD_MODULE_LIST type="ORDEREDLIST" >
<bi:MOD_SINGLE_MODULE type="COMPOSITE" index="2" >
<bi:ACTIVE value="X" />
<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >
<bi:MOD_GENERIC_MODULE type="COMPOSITE" >
<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.DocumentContent" />
<bi:MOD_PARAMETER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAMETER type="COMPOSITE" index="1" >
<bi:MOD_PARAM_NAME value="DISPLAY_IMAGE_URL" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" />
</bi:MOD_PARAMETER>
<bi:MOD_PARAMETER type="COMPOSITE" index="2" >
<bi:MOD_PARAM_NAME value="IMAGE_URL_PREFIX" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="STRING" >
<bi:STRING value="http://hostanme:1080/sap/bw/mime/customer/images/products/" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PARAMETER>
<bi:MOD_PARAMETER type="COMPOSITE" index="3" >
<bi:MOD_PARAM_NAME value="IMAGE_URL_SUFFIX" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="STRING" >
<bi:STRING value=".jpg" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PARAMETER>
<bi:MOD_PARAMETER type="COMPOSITE" index="4" >
<bi:MOD_PARAM_NAME value="COLUMN" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" />
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="CHARACTERISTIC" >
<bi:CHARACTERISTIC value="0D_PH2" text="0D_PH2" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
</bi:MOD_PARAMETER>
<bi:MOD_PARAMETER type="COMPOSITE" index="5" >
<bi:MOD_PARAM_NAME value="CAPTION" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="STRING" >
<bi:STRING value="URL" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PARAMETER>
<bi:MOD_PARAMETER type="COMPOSITE" index="6" >
<bi:MOD_PARAM_NAME value="WIDTH" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="120" />
</bi:MOD_PARAM_VALUE>
Analysis Web Item: Using Parameter Modification
45
SAP Online Help
31.05.2010
</bi:MOD_PARAMETER>
<bi:MOD_PARAMETER type="COMPOSITE" index="7" >
<bi:MOD_PARAM_NAME value="HEIGHT" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="120" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PARAMETER>
</bi:MOD_PARAMETER_LIST>
</bi:MOD_GENERIC_MODULE>
</bi:MOD_SELECT>
</bi:MOD_SINGLE_MODULE>
<bi:MOD_SINGLE_MODULE type="COMPOSITE" index="1" >
<bi:ACTIVE value="X" />
<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >
<bi:MOD_GENERIC_MODULE type="COMPOSITE" >
<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.ColumnWidth" />
<bi:MOD_PARAMETER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAMETER type="COMPOSITE" index="1" >
<bi:MOD_PARAM_NAME value="COLUMN[*]" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" />
</bi:MOD_PARAMETER>
<bi:MOD_PARAMETER type="COMPOSITE" index="2" >
<bi:MOD_PARAM_NAME value="COLUMN_FIX[*]" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="150" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PARAMETER>
</bi:MOD_PARAMETER_LIST>
</bi:MOD_GENERIC_MODULE>
</bi:MOD_SELECT>
</bi:MOD_SINGLE_MODULE>
</bi:MOD_MODULE_LIST>
</bi:MODIFICATION>
</bi:ANALYSIS_ITEM>
Analysis Web Item: Using Parameter Modification
46
SAP Online Help
31.05.2010
Example: ‘Planning’ Module
Definition
The Planning module (com.sap.ip.bi.rig.Planning) contains the following
enhancements for planning applications in BEx Web:
Copy and paste
Select entire cell content by clicking
Jump to the next cell by pressing the Enter key.
For more information on the Copy and Paste function, see Example: Copy and Paste Module
[Seite 50].
Note that you need to call three JavaScript functions to be able to copy and
paste.
If the function Select entire cell content by clicking is activated, clicking on a cell not only
places the cursor in the cell, but also selects all of the cell’s content. This means that you can
click a cell and overwrite the contents immediately.
The function Jump to the next cell by pressing the Enter key is an enhancement that enables
you to enter data in multiple cells. Pressing the Enter key closes the current cell and selects
the next cell. Using the option NEXT_CELL_ROW_FIRST, you can specify whether the
system should search for the next input-ready cell in the same row or in the next row.
The technical name of this implementation is com.sap.ip.bi.rig.Planning.
Note that access to the clipboard is deactivated by default in many Web
browsers for security reasons. Activate access to the clipboard.
Microsoft Internet Explorer 7.0
(http://msdn.microsoft.com/en-us/library/bb250473(VS.85).aspx)
Microsoft Internet Explorer 6.0
(http://support.microsoft.com/kb/224993)
Mozilla Firefox
(http://kb.mozillazine.org/Granting_JavaScript_access_to_the_clipboard)
More information:
Using Modifications [Seite 8]
Make sure that the module is activated. Otherwise the planning enhancements
will not be available.
Example: Planning Module
<bi:ANALYSIS_ITEM name="ANALYSIS_ITEM_1" designwidth="400" designheight="200" >
<bi:DATA_PROVIDER_REF value="DP_1" />
<bi:MODIFICATION type="CHOICE" value="MOD_SINGLE_MODULE" >
<bi:MOD_SINGLE_MODULE type="COMPOSITE" >
<bi:ACTIVE value="X" />
<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >
<bi:MOD_GENERIC_MODULE type="COMPOSITE" >
<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.Planning" />
Analysis Web Item: Using Parameter Modification
47
SAP Online Help
31.05.2010
</bi:MOD_GENERIC_MODULE>
</bi:MOD_SELECT>
</bi:MOD_SINGLE_MODULE>
</bi:MODIFICATION>
</bi:ANALYSIS_ITEM>
All three functions are activated by default. You can deactivate individual enhancements as
required by using the following options.
Deactivating Copy and Paste
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
DISABLE_COPY_PASTE
You can use this parameter to
deactivate the Copy and Paste
function.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example: Deactivating the Copy and Paste function
<bi:MOD_PARAM_NAME value="DISABLE_COPY_PASTE" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Deactivate Paste and Overwrite
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
DISABLE_PASTE_OVERWRI
TE
By default, the JavaScript
function Paste
(sapbi_rig_cp_paste_cli
pboard) keeps overwriting
rows and columns until all the
data in the clipboard has been
pasted (even if the selected
paste area is smaller than
required). This parameter
deactivates this behavior.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example: Deactivating paste and overwrite
<bi:MOD_PARAM_NAME value="DISABLE_PASTE_OVERWRITE" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Deactivating Select Cell Content
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
DISABLE_SELECT_ON_CLICK
This parameter deactivates
the function that selects the
cell content when you click on
a cell.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example: Deactivating Select Cell Content
<bi:MOD_PARAM_NAME value="DISABLE_SELECT_ON_CLICK" />
Analysis Web Item: Using Parameter Modification
48
SAP Online Help
31.05.2010
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Deactivating Jump By Pressing Enter
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
DISABLE_NEXT_CELL_ON_RETUR
N
This parameter deactivates
the function that enables you
to jump to the next cell by
pressing the Enter key.
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example: Deactivating Jump By Pressing Enter
<bi:MOD_PARAM_NAME value="DISABLE_NEXT_CELL_ON_RETURN" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Jumping to the Next Cell by Pressing the Enter Key
Parameter
Value
Description
Name/Expression
(MOD_PARAM_NAME)
NEXT_CELL_ROW_FIRST
This parameter specifies
which direction the system
searches in, to find the next
input-ready cell to be selected.
By default, the system
searches for a cell in the same
row (to the right of the current
column). The parameter
changes this behavior so that
the system searches for an
input-ready cell in the next row
(same column).
Value
(MOD_PARAM_VALUE)
Boolean
Active
Example: Jumping to the Next Cell by Pressing the Enter Key
<bi:MOD_PARAM_NAME value="NEXT_CELL_ROW_FIRST" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Analysis Web Item: Using Parameter Modification
49
SAP Online Help
31.05.2010
Example: ‘Copy and Paste’ Module
Definition
The Copy and Paste module (com.sap.ip.bi.rig.CopyPaste) inserts three JavaScript
functions into the Web template. These JavaScript functions enable you to copy and paste
text in the Analyse Web item. Text can only be pasted into input-ready cells (planning).
You can select a cell in the Analysis Web item by clicking on it with the left mouse button.
Hold down the shift key and click the mouse button again to select multiple cells in the
Analysis Web item.
It is not possible to select cells using the Row Selection (SELECT_ROWS) parameter in the
Analysis Web item.
The technical name of the implementation is com.sap.ip.bi.rig.CopyPaste.
You can choose from the following JavaScript functions:
You can call these JavaScript functions using a Web item Button Group.
sapbi_rig_cp_copy_clipboard
The content of all the selected cells is copied to the clipboard. If cells are selected from
multiple columns, the contents of the columns are separated by a tab character. If cells
are selected from multiple rows, the contents of the rows are separated by a line break.
This makes it easier to paste the copied cells into Microsoft Excel, for example.
sapbi_rig_cp_paste_clipboard
The content of input-ready and selected cells is replaced by the content in the
clipboard. Cells that are not input-ready cells are ignored. However, these non-inputready cells are important if the same area is used for copying and pasting.
sapbi_rig_cp_clear
The content of the input-ready, selected cells is deleted.
Note that access to the clipboard is deactivated by default in many Web
browsers for security reasons. Activate access to the clipboard.
Microsoft Internet Explorer 7.0
(http://msdn.microsoft.com/en-us/library/bb250473(VS.85).aspx)
Microsoft Internet Explorer 6.0
(http://support.microsoft.com/kb/224993)
Mozilla Firefox
(http://kb.mozillazine.org/Granting_JavaScript_access_to_the_clipboard)
More information:
Using Modifications [Seite 8]
Make sure that the module is activated. Otherwise the JavaScript functions for
copying and pasting will not be available.
Analysis Web Item: Using Parameter Modification
50
SAP Online Help
31.05.2010
Example: ‘Copy and Paste’ Module
<bi:ANALYSIS_ITEM name="ANALYSIS_ITEM_1" designwidth="400" designheight="200" >
<bi:DATA_PROVIDER_REF value="DP_1" />
<bi:MODIFICATION type="CHOICE" value="MOD_SINGLE_MODULE" >
<bi:MOD_SINGLE_MODULE type="COMPOSITE" >
<bi:ACTIVE value="X" />
<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >
<bi:MOD_GENERIC_MODULE type="COMPOSITE" >
<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.CopyPaste" />
</bi:MOD_GENERIC_MODULE>
</bi:MOD_SELECT>
</bi:MOD_SINGLE_MODULE>
</bi:MODIFICATION>
</bi:ANALYSIS_ITEM>
Example: Buttons that call the JavaScript functions
<bi:BUTTON_GROUP_ITEM name="BUTTON_GROUP_COPY_PASTE" designheight="23" designwidth="50"
>
<bi:WIDTH value="50" />
<bi:BUTTON_LIST type="ORDEREDLIST" >
<bi:BUTTON type="COMPOSITE" index="1" >
<bi:CAPTION value="Copy" />
<bi:ACTION type="CHOICE" value="SCRIPT_FUNCTION" >
<bi:SCRIPT_FUNCTION value="sapbi_rig_cp_copy_clipboard" />
</bi:ACTION>
</bi:BUTTON>
<bi:BUTTON type="COMPOSITE" index="2" >
<bi:CAPTION value="Paste" />
<bi:ACTION type="CHOICE" value="SCRIPT_FUNCTION" >
<bi:SCRIPT_FUNCTION value="sapbi_rig_cp_paste_clipboard" />
</bi:ACTION>
</bi:BUTTON>
<bi:BUTTON type="COMPOSITE" index="3" >
<bi:CAPTION value="Clear Selected Cells" />
<bi:ACTION type="CHOICE" value="SCRIPT_FUNCTION" >
<bi:SCRIPT_FUNCTION value="sapbi_rig_cp_clear" />
</bi:ACTION>
</bi:BUTTON>
</bi:BUTTON_LIST>
</bi:BUTTON_GROUP_ITEM>
Analysis Web Item: Using Parameter Modification
51