*Modification required to running board assembly. See Item ...
Analysis Web Item Parameter Modification - Part 1
-
Upload
gustavo-yasuda -
Category
Documents
-
view
218 -
download
0
Transcript of Analysis Web Item Parameter Modification - Part 1
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
1/51
A n al y s i s Web It em : Us i n gParameter Mod i f i ca t i on
HELP.BW
_INTERNAL
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
2/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 2
Copyright
Copyright 2010 SAP AG. All rights reserved.
No part of this publication may be reproduced or transmitted in any form or for any purposewithout 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 proprietarysoftware components of other software vendors.
Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of MicrosoftCorporation.
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, DB2Connect, 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 registeredtrademarks 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 aretrademarks or registered trademarks of Citrix Systems, Inc.
HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, WorldWide Web Consortium, Massachusetts Institute of Technology.
J ava is a registered trademark of Sun Microsystems, Inc.
J avaScript is a registered trademark of Sun Microsystems, Inc., used under license fortechnology invented and implemented by Netscape.
SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, Clear Enterprise, SAPBusinessObjects Explorer and other SAP products and services mentioned herein as well astheir respective logos are trademarks or registered trademarks of SAP AG in Germany andother countries.
Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, CrystalDecisions, Web Intelligence, Xcelsius, and other Business Objects products and servicesmentioned herein as well as their respective logos are trademarks or registered trademarks ofSAP France in the United States and in other countries.
All other product and service names mentioned are the trademarks of their respectivecompanies. Data contained in this document serves informational purposes only. Nationalproduct specifications may vary.
These materials are subject to change without notice. These materials are provided by SAPAG and its affiliated companies ("SAP Group") for informational purposes only, withoutrepresentation or warranty of any kind, and SAP Group shall not be liable for errors or
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
3/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 3
omissions with respect to the materials. The only warranties for SAP Group products andservices are those that are set forth in the express warranty statements accompanying suchproducts and services, if any. Nothing herein should be construed as constituting anadditional warranty
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
4/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 4
Icons in Body Text
Icon Meaning
Caution
ExampleNote
Recommendation
Syntax
Additional icons are used in SAP Library documentation to help you identify different types ofinformation at a glance. For more information, see Help on Help General InformationClasses and Information Classes for Business Information Warehouse on the first page of anyversion ofSAP Library.
Typographic Conventions
Type Style Description
Example text Words or characters quoted from the screen. These include fieldnames, 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 tabletitles.
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, forexample, SELECT and INCLUDE.
Exampl e t ext Output on the screen. This includes file and directory names and theirpaths, messages, names of variables and parameters, source text, andnames of installation, upgrade and database tools.
Example text Exact user entry. These are words or characters that you enter in thesystem exactly as they appear in the documentation.
Variable user entry. Angle brackets indicate that you replace thesewords and characters with appropriate entries to make entries in thesystem.
EXAMPLE TEXT Keys on the keyboard, for example, F2 or ENTER.
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
5/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 5
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
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
6/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 6
Analysis Web Item: Using Parameter Modification
Use
If you do not want to use the default display and behavior of theAnalysis Web item, you can
use the Modification parameter to change them. You can modify the table structure and thetable cells.
The Modification parameter provides modules whose use can be controlled using additionalparameters.
This function enables you to use similar options to those available in earlier releases with theWeb Design API for Tables. Unlike the Web Design API for Tables, modifications enable youto make targeted changes to the display and behavior without any programming.
Prerequisites
The modules are the main prerequisites for making modifications to theAnalysis Web item.The modules are implemented in J ava. The SAP Basis infrastructure in SAP NetWeaver 7.0does not support any customer modifications or extensions to J ava coding. Customers aretherefore not able to develop their own modules for modifications to theAnalysis Web item.
SAP delivers a number of sample modules. You can use parameters to modify the displayand behavior of these modules.
Note that the modification modules use and manipulate the standardimplementation of theAnalysis Web item. This may mean that specificrequirements are not met. SAP tries to eliminate any potential problems.However, situations can occur that require the standard implementation to bemodified. This type of modification is not possible in every case.
Therefore the modules are only described as examples. The modules can beused productively. However, you are not entitled to assistance from SAPsupport.
Procedure
You use the modules as follows:...
1. Select a module from the sample modules.
2. Specify the module in the Modification parameter of theAnalysis Web item.
3. Control the display and behavior of the module by specifying the module-specificparameters.
More information: Using Modifications [Seite 8]
Result
The table of theAnalysis 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 fortable 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]
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
7/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 7
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
8/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 8
Using Modifications
Use
In Web itemAnalysis, 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 usingmore than one module, follow the sequence of the modules. Changed rows are passed on tosubsequent modules for further processing.
A module is only called if it is active. TheActive parameter can be used to active anddeactivate modules at runtime.
The default value for parameterActive is inactive, meaning that that module willnot 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 affectsoutput in HTML, for example, and not output in PDF.
You can find a list of possible modules underExamples of Modules [Seite 12].
Structure
The parameters that a module can have depend on the module: The documentation for themodules describes which parameters are supported and their meaning. The following is ageneral description of the parameters.
Modification
Parameter Description
Modification (MODIFICATION) You can use this parameter to specify onemore modules that change the display orbehavior of Web itemAnalysis.
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 onesingle module.
Module List (MOD_MODULE_LIST) This selection makes it possible to specify a listof single modules. The modules are called in
the specified sequence, meaning thatsubsequent modules modify existing cells.
This means for example that the column widthscan be defined first, and that comments canthen be displayed in a given column.
Single Module
Parameter Description
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
9/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 9
Alias (MOD_ALIAS) TheAlias parameter makes it possible to entera name. The name is displayed in the Webitem parameters and simplifies identification ofa module. The alias is particularly important forthe Set Status of Module [Extern] command ifseveral modules are being used.
Active(ACTIVE) TheActive parameter defines whether amodule is active or not. If it is not active, the
table is not modified. You can use thisparameter and the Set Status of Module[Extern] command to activate or deactivate amodification at runtime.
Formats (MOD_TARGETS) You use this parameter to define the formatsfor 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. Thismeans that a modification can only be used incertain formats.
Type (MOD_SELECT) This parameter always has the value GenericModule (MOD_GENERIC_MODULE). Thedetails of this parameter are described below.
Generic Module
Parameter Description
Name of the Implementation(MOD_REFERENCE)
You use this parameter to specify the technicalname of the module.
You can find a list of possible values underExamples of Modules [Seite 12].
Parameter List (MOD_PARAMETER_LIST) The parameter list contains one or moreparameters (PARAMETER). The parametersthat can be used depends on the chosenmodule: The parameters are generic and canbe used flexibly. Selecting the type makesspecific input help possible. The details for aparameter are described below.
Parameter
Parameter Description
Name/Expression (MOD_PARAM_NAME) You use this parameter to specify the technicalname of a parameter.
You can find the possible values in thedocumentation for the individual modules. Aswell as technical names, modules can supportsimple expressions.
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
10/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 10
Value (MOD_PARAM_VALUE) The value of a parameter has a certain type.Depending on this type, a value can bespecified.
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_OBJ ECT_ATTRIBUTE)
Data Cell (DATA_CELL)
Array (MOD_VALUE_ARRAY)
Selecting a type makes specific input helppossible for each type.
IfAction is selected, the command wizardstarts. IfData Provideris selected, all dataproviders in the Web template are displayed.
In some cases, the generic inputhelp does not provide therequired values. Whenever thishappens, you need to enter thetechnical name manually. Youcan use Query Designer to findthe technical names of structures,structural components and so on.
Placeholder List(MOD_PLACEHOLDER_LIST)
With some modules, it is necessary to specifymore than one value. You can use theplaceholder list to do this.
The Name/Expression parameter can containplaceholders that are replaced with the valuesin the placeholder list.
The values in the placeholder list also have atype. The available types are described underthe Value parameter (MOD_PARAM_VALUE).
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
11/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 11
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
12/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 12
Examples of Modules
This section contains a list with descriptions of the modules that you can use to personalizethe display and behavior of theAnalysis Web item.
Column Width module
You use this module to define the width of individual columns in theAnalysis 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 theAnalysis 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]
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
13/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 13
Example: Column Width Module
Definition
The Column Width module (com.sap.ip.bi.rig.ColumnWidth) enables the
definition of the column width in theAnalysis Web item. There are several possibilities forspecifying 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 theparameter Column (COLUMN) orRow (ROW). The possibilitiesavailable here for entering a column are the same as for themodule Set Column Width. Note that the value might be Booleanrather 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 notexplicitly specified have the width 0. This means that they are notvisible.
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. TheCOLUMN parameter name must be different for each column. You must therefore add anumber to the names. There are the following supported ways of doing this:
COLUMN[]
COLUMN_
Make sure that the module is activated. If not, the column widths do not change.
Example
... (add parameter here, see below for details)
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
14/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 14
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 ismade 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 notspecify 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[*]
COLUMN_DEFAULT
Default column
Value(MOD_PARAM_VALUE)
Integer Width in pixels
Example for default width of 50
Default width for fixed columns
The default width for fixed columns is used for characteristic and key figure columns in thedrilldown.
Default width fo r fi xed columns
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
COLUMN_FIX
COLUMN_FIX[*]
COLUMN_FIX_DEFAULT
Default column
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 setindependently of the current navigational state. If the navigational state changes, the contentof the specified column might relate to a different characteristic or key figure.
Default width for specific index
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
15/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 15
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
COLUMN[]
COLUMN_
is the column. Thefirst column has index 1.
Value(MOD_PARAM_VALUE)
Integer Width in pixels
Placeholder List(MOD_PLACEHOLDER_LIST)
Blank Leave Placeholder List blank.
Example for column width of 100 for column with index 5 and index 6
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
16/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 16
Default width for specific characteristic
The column is determined by the specification of a characteristic. The column with thespecified characteristic is always modified in line with the specified width. This is independentof the navigational state.
Default width for specific characteristic
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
COLUMN[]
COLUMN_
is the sequentialnumber.
Value(MOD_PARAM_VALUE)
Integer Width in pixels
Placeholder List(MOD_PLACEHOLDER_LIST)
Type =characteristic, value =
is thetechnical name of thecharacteristic.
Example for column width of 200 for product characteristic (0D_PH2)
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 specifiedwidth. This is independent of the navigational state.
Default width for specific characteristic value
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
COLUMN[]
COLUMN_
is the sequentialnumber.
Value(MOD_PARAM_VALUE)
Integer Width in pixels
Placeholder List(MOD_PLACEHOLDER_LIST)
Types Characteristic Valueand Value consisting ofand
is thetechnical name of thecharacteristic and isthe technical characteristicvalue
Example for column width of 200 for characteristic value PDS12 of the characteristicproduct (0D_PH2)
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
17/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 17
Default width for specific attribute
The column is determined by the specification of an attribute. The column with the specifiedattribute is always modified in line with the specified width. This is independent of thenavigational state.
Default width for specific attribute
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
COLUMN[]
COLUMN_
is the sequentialnumber.
Value(MOD_PARAM_VALUE)
Integer Width in pixels
Placeholder List(MOD_PLACEHOLDER_LIST)
Type =attribute, value =
is the technicalname of the attribute.
Example for co lumn wid th of 200 for pri ce attribute (0D_PREIS)
Default width for specific member
The column is determined by the specification of a structure member (key figure). The columnwith the specified structure member (key figure) is always modified in line with the specifiedwidth. This is independent of the navigational state.
A structure value is generally a key figure. However, it can also be a selection ora 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 theEnhanced tab page.
If you assign a technical name in the properties of the BEx Query Designer, youcan specify a technical name.
Structure value is actually a dropdown box. Press F11 to make the field input-ready. You can then insert the technical name of the key figure from the querydefinition.
Default width for specific member
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
COLUMN[]
COLUMN_
is the sequentialnumber.
Value(MOD_PARAM_VALUE)
Integer Width in pixels
Placeholder List(MOD_PLACEHOLDER_LIST)
Type =structure member,value =
is thetechnical name of the structuremember (key figure).
Example for column w idth of 150 for key figure
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
18/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 18
Continuous text with automatic line b reaks (optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
WRAPPING Using this parameter, you canspecify whether the headersare displayed as continuoustext. Line breaks areautomatically added to thecontinuous text.
Value(MOD_PARAM_VALUE)
Boolean Active
Example: automatic line breaks in headers
Continuous text for all lines (optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
ALL_ROWS_WRAPPING Using this parameter, you canspecify whether all lines aredisplayed as continuous text.Line breaks are automaticallyadded to the continuous text.
Value(MOD_PARAM_VALUE) Boolean Active
Note that preparing the continuous text is very time-consuming. Only use thisparameter if you really need continuous text.
Example: automatic line breaks in all lines
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
19/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 19
Example: Negative Number Module
Definition
The Negative Numbermodule (com.sap.ip.bi.rig.NegativeNumber) depicts
negative numbers in a column or entire table in red. Other types of formatting are notcurrently 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 notformatted.
Example
The following section describes the various options offered in this module. The options arespecified as parameters in the parameter list (MOD_PARAMETER_LIST). A parameterconsists of a Name/Expression (MOD_PARAM_NAME), Value (MOD_PARAM_VALUE) andPlaceholder List (MOD_PLACEHOLDER_LIST). If you do not specify the Placeholder Listparameter, 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 canspecify the column whosenegative numbers areformatted.
The Set Column Width Module[Seite 13] module describesthe possible options forspecifying a column as aparameter.
Value(MOD_PARAM_VALUE)
Boolean Active
Example for formatted negative numbers in the column with index 3
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
20/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 20
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
21/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 21
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 theAnalysis Web item. The documentscan 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 ofdocument content. You can use the Width parameter to set thewidth of the columns with document content.
Note that only the first comment or the first image in a cell isshown.
The parametersAction Open Document andAction Create Comment simplify user
interaction. If a document exists for a cell, a dialog box opens when you click on the cell. Thisdialog box displays the document and also contains the functionality of the Web Item list ofdocuments. If no document exists for this cell, you can click on the cell to open a dialog boxwhere 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 Widthmodule 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 willnot be displayed.
Example forColumn Width and Document Content modules
... (add parameter here, see below for details)
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
22/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 22
... (add parameter here, see below for details)
The section below describes the options offered in this module. These options influence howthe 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 listedhere.
Displaying Comments
You need to choose a document display that allows you to choose between displayingcomments, images or links. It is not possible to combine the display of different documenttypes (for example, to display comments and images).
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
DISPLAY_TEXT_PLAIN The selected column displaysthe content of comments.Comments are unformattedtext. Only the first comment ina cell is shown.
Value(MOD_PARAM_VALUE)
Boolean Active
Example
Displaying Images
You need to choose a document display that allows you to choose between displayingcomments, images or links. It is not possible to combine the display of different documenttypes (for example, to display comments and images).
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
DISPLAY_IMAGE Any documents that areimages are displayed in theselected column. Only the firstimage in a cell is shown.
Value(MOD_PARAM_VALUE)
Boolean Active
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
23/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 23
Example
Displaying Links
You need to choose a document display that allows you to choose between displayingcomments, images or links. It is not possible to combine the display of different documenttypes (for example, to display comments and images).
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
DISPLAY_LINK The documents are displayedas links in the selectedcolumn. All the documents of acell are shown as links withinthe relevant cell.
Value(MOD_PARAM_VALUE)
Boolean Active
Example
Column
You must specify a column.
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
COLUMN You use this parameter tospecify the column with thevalue that you want to replacewith document content.
The Set Column Width moduledescribes the possible optionsfor specifying a column as aparameter.
More information: Example:Column Width Module [Seite13]
Wert (MOD_PARAM_VALUE) Boolean Active
Example for displaying document content in column with index 3
Width
It is recommended that you specify a column width because the default column width isusually too narrow for displaying documentation contents.
Parameter Value Description
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
24/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 24
Name/Expression(MOD_PARAM_NAME)
WIDTH Width of column in which todisplay document content.
Value(MOD_PARAM_VALUE)
Integer Width in pixels
Example for a column width of 200
Height (Display of Images Only)
To display images, you need to enter the height as the system cannot calculate the size of theimages. 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 whichdocument content isdisplayed.
Value
(MOD_PARAM_VALUE)
Integer Height in pixels
Example with Row Height 100
Act ion: 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 youclick on the cell. This dialog
box displays the documentand also contains thefunctionality of the Web Itemlist of documents. Moreinformation: List of Documents[Extern]
Value(MOD_PARAM_VALUE)
Boolean Active
Example for Action Document Open, if document exists
Action: Create Comment (optional )
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
ACTION_NEW_COMMENT_ON_CLICK If no document existsfor this cell, you canclick on the cell to opena dialog box where youcan create a newcomment.
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
25/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 25
Value(MOD_PARAM_VALUE)
Boolean Active
Example for Create Action Comment, if no document exists
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
Heading (optional)
You can enter any text for the column heading. It is not possible to use a language-dependenttext as a parameter. You can define a language-dependent text for the query in BEx QueryDesigner.
Parameter Value Description
Name/Expression
(MOD_PARAM_NAME)
CAPTION Column heading
Value(MOD_PARAM_VALUE)
Character string Text
Example for left alignment
Results Row (optional)
Generally it only useful to show documents for characteristic values or data cells. If you alsowant to display documents in the results rows, you need to activate this parameter.
Parameter Value DescriptionName/Expression(MOD_PARAM_NAME)
RESULT Display documents in resultsrows
Value(MOD_PARAM_VALUE)
Boolean Active
Example for Create Action Comment, if no document exists
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
26/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 26
Maximum Length of Document Content (optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
MAX_CONTENT_LENGTH Maximum length of documentcontent after which any further
content is truncated. The factthat content is truncated isindicated by ....
Value(MOD_PARAM_VALUE)
Integer Length in characters
Example for limi t of 1000 characters
Correction for Character Set (opt ional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
FONT_SIZE_OFFSET You use this parameter toinfluence the calculation of theoptimal row height.
You only require thisparameter if another characterset is used in the portal theme.
Value(MOD_PARAM_VALUE)
Integer Positive or negative correctionto correct the character width.
Example for l arger character set with correction of 2
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
27/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 27
Example: Empty Cells as Non Input-EnabledModule
Definition
Using the Empty Cells as Non Input-Enabled module(com.sap.ip.bi.rig.NonInputableEmptyCells) you can make input-enabled cells non input-enabled.
In BI Integrated planning, automatic creation of rows and/or columns can lead to cells beingcreated that are input enabled from a technical point of view, but for process reasons shouldnot be input-enabled in one or more queries. Cells like these are normally locked using dataslices, which means though that these combinations are locked against changes (includingchanges by planning functions) in the entire system. If you only want the lock to apply in oneor more queries, you can override the input-enabledness of the cells in the Web Itemanalysis, using the module.
The technical name of this implementation iscom.sap.ip.bi.rig.NonInputableEmptyCells.
Make sure that the module is activated. Otherwise, empty cells will remain inputenabled.
Example
The section below describes the options offered in this module. These options influence howthe 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 canspecify the column containingthe empty cells that you dontwant to set to input-enabled.
The Set Column Width module
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
28/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 28
describes the possible optionsfor specifying a column as aparameter.
More information: Example:Column Width Module [Seite13]
Value(MOD_PARAM_VALUE) Boolean Active
Example with non input-enabled empty cells in column with index 3
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
29/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 29
Example: Own Symbols for Exception Module
Definition
The Own Symbols for Exception module
(com.sap.ip.bi.rig.ExceptionImage) enables you to display exceptions withyour 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 retainedfor this alert level.
The way the module functions depends on the display type of the exceptions defined usingparameter Exception Display (EXCEPTION_RENDERING) in Web ItemAnalysis. The maindifference 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 asthe standard setting. No symbols are displayed with the display type. The modules also hasparameter Display Type with Exception Display with Color(EXCEPTION_RENDERING_COLOR). You can use this parameter to select how thebackground 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) orText 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 iscom.sap.ip.bi.rig.ExceptionImage.
Make sure that the module is activated. Otherwise, the symbols will not bechanged.
Example
...(addparameterhere,seebelowfordetails)
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
30/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 30
The section below describes the options offered in this module. These options influence howthe 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 nextparameter) need to be specified .
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
ALERT_GOOD,ALERT_CRITICAL,ALERT_BAD
You can use these threeparameters to specify the URLor path in the MIME repository(SE80) for your own symbols.You can use these parametersto set symbols for the threealert levels Good, Critical andBad.
Value(MOD_PARAM_VALUE)
Image URL or path in the MIMERepository:
Example of a symbol from the MIME reposi tory
Symbols for Nine-Level Alert Levels
Either the parameters for the three-level alert levels (see previous parameter) or the nine-level alert levels need to be specified
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
ALERT_1 to ALERT_9 You can use these nineparameters to specify the URLor path in the MIME repository(SE80) for your own symbols.You can use this parameter to
set symbols for all nine alertlevels.
ALERT_1 equates toGood 1
ALERT_2 equates toGood 2
ALERT_3 equates toGood 3
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
31/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 31
ALERT_4 equates toCritical 1
ALERT_5 equates toCritical 2
ALERT_6 equates toCritical 3
ALERT_7 equates toBad 1
ALERT_8 equates toBad 2
ALERT_9 equates toBad 3
Value(MOD_PARAM_VALUE)
Image URL or path in the MIMERepository:
Example of a symbol from the MIME reposi tory
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 tospecify the column whoseexceptions you want toreplace with your ownsymbols.
The Set Column Width moduledescribes the possible options
for specifying a column as aparameter. More information:Example: Column WidthModule [Seite 13]
Value(MOD_PARAM_VALUE)
Boolean Active
Example for displaying document content in column with i ndex 3
Alignment (Optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
ALIGNMENT Alignment
Value Character string Possible values are:
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
32/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 32
(MOD_PARAM_VALUE) Left (LEFT)
Centered (CENTER)
Right (RIGHT)
The default value is Centered.
Example for left alignment
Height (Optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
HEIGHT Height of the row in pixels. Itmight be necessary to specifythe height if the height of oneof your own symbols is greaterthan the standard height of arow.
Value(MOD_PARAM_VALUE)
Integer Height in pixels
Example with a height of 20 pixels
Display Type with Exception Display with Color (Optional)
Parameter Display Type with Exception Display with Coloris only valid if Web Item Analysisparameter Exception Display (EXCEPTION_RENDERING) has the value Color (COLOR).With all other exception display types, parameter EXCEPTION_RENDERING_COLOR isignored.
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
EXCEPTION_RENDERING_COLOR This parameter enables youto decide whether to displayjust the symbol or the symboland the text together. Youcan also define whether thesymbol appears to the left ofthe text or the right.
Value(MOD_PARAM_VALUE)
Character string The following display optionsare available:
Symbol and Text(SYMBOL_TEXT)
Text and Symbol(TEXT_SYMBOL)
Symbol Only(SYMBOL)
Example with the exception displayed as a symbol with b ackground color
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
33/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 33
Distance Between Symbol and Content (Optional)
Parameter Distance Between Symbol and Content is only valid if Web Item Analysisparameter 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)
SEPARATORYou cam use this parameter to setthe distance in pixels between thetext and the symbol. (See parameterEXCEPTION_RENDERING_COLOR)
Wert (MOD_PARAM_VALUE) Integer Number of pixels
Example with a distance of 5 pixels
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
34/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 34
Example: Format Cells Module
Definition
The Format Cells module (com.sap.ip.bi.rig.Format) enables you to specifically
format cells in theAnalysis 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. Cellscan 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 typeTotal 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 anAnalysis 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 bedisplayed.
Example: Format Cells Types Module
...(addparameterhere,seebelowfordetails)
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
35/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 35
The section below describes the options offered in this module. These options influence howthe 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 threemethods. 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
CELL_STANDARD CELL_DISABLED
CELL_READ_ONLY CELL_ALTERNATING CELL_TRANSPARENTCELL_HEADER
CELL_TITLE CELL_LEVEL1HEADER CELL_LEVEL2HEADERCELL_LEVEL3HEADER CELL_ALERT_9_BAD_STRONGCELL_ALERT_8_BAD_MEDIUMCELL_ALERT_7_BAD_LIGHTCELL_ALERT_6_CRITICAL_STRONGCELL_ALERT_5_CRITICAL_MEDIUMCELL_ALERT_4_CRITICAL_LIGHT CELL_ALERT_3_GOOD_LIGHTCELL_ALERT_2_GOOD_MEDIUMCELL_ALERT_1_GOOD_STRONG
CELL_NEGATIVE CELL_POSITIVE CELL_TOTALCELL_SUBTOTAL CELL_SUBTOTAL_LIGHTCELL_GROUP_HIGHLIGHTEDCELL_GROUP_HIGHLIGHTED_LIGHT CELL_KEY_MEDIUM,CELL_GROUP_LEVEL1 CELL_GROUP_LEVEL2CELL_GROUP_LEVEL3 CELL_HIERARCHY_LEVEL1CELL_HIERARCHY_LEVEL2
CELL_HIERARCHY_LEVEL3 CELL_HIERARCHY_LEVEL4CELL_FILTER CELL_FILTERICON CELL_MARKEDCELL_SELECTED1 CELL_SELECTED2 CELL_SELECTED3CELL_SELECTED4 CELL_SELECTED5
The cell typehere can beselected toformat thecorrespondicells.ParameterCELL_DEBUdisplays thecell type of acells.
Value(MOD_PARAM_VALUE)
Boolean Active
Example with formatting for cell t ype CELL_HEADER
Column
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
COLUMN You can use this parameter tospecify the column with thecells to be formatted.The Set Column Width moduledescribes the options for
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
36/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 36
specifying a column as aparameter.More information:
Example: Set Column WidthModule [Seite 13]
Value
(MOD_PARAM_VALUE)
Boolean Active
Example with formatting in column 1 with index 3
Row
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
ROW You can use this parameter tospecify the row with the cellsto be formatted.The Set Column Width moduledescribes the options forspecifying a row as aparameter.Note that parameter COLUMNmust be replaced with ROW.More information:
Example: Set Column WidthModule [Seite 13]
Value(MOD_PARAM_VALUE)
Boolean Active
Example with formatting in row with index 5
Text Color (Optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
COLOR You can use this parameter toselect the text color.
Value(MOD_PARAM_VALUE)
Character string The color can be specifiedeither as a hexadecimal valueor as a color name.
Example with dark-green text color
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
37/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 37
Background Color (Optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
BACKGROUND_COLOR You can use this parameter toselect the background color.
Value(MOD_PARAM_VALUE)
Character string The color can be specifiedeither as a hexadecimal valueor as a color name.
Example with black background
Bold Text (Optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
BOLD You can use this parameter toset bold text.
Value(MOD_PARAM_VALUE)
Boolean Active
Example
Italic Text (Optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
ITALIC You can use this parameter toactivate italic text.
Value(MOD_PARAM_VALUE)
Boolean Active
Example
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
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
38/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 38
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
Display Cell Types (Optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
CELL_DEBUG Parameter CELL_DEBUGdisplays the cells with therelevant cell type, column, rowand the characteristic value,structure value or value. Youcan use this parameter toformat a specific cell, columnor row.
Value(MOD_PARAM_VALUE)
Boolean Active
Example
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
39/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 39
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 ItemAnalysis.The header rows contain the column headers. The leading columns normally contain thecharacteristics.
The ideal height and width of Web ItemAnalysis can be specified as a value or J avaScriptvariable. The J avaScript variable can be used to set the height and width in accordance withthe window size of the web browser.
We recommend configuring the settings in Web ItemAnalysis sothat all data rows and columns are displayed. To do this, setparameters BLOCK_COLUMNS_SIZE and BLOCK_ROWS_SIZEto 0.
Note that displaying a large table with fixed rows and columnscan cause performance problems both for the client and for theserver. You can therefore limit the display. You can define a limitafter which a warning message and another after which an errormessage is displayed. For the error message, the table isdisplayed without fixed rows and columns. Parameters Row andColumn enable you to specify fixed rows and columns, to fix justthe first column for example. If these parameters are not set, theheader rows and the leading columns are fixed. The data cellscan 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 willnot be fixed.
Example with Fix Rows and Columns Module
...(addparameterhere,seebelowfordetails)
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
40/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 40
The section below describes the options offered in this module. These options influence howthe 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 listedhere.
Width (Optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
WIDTH You can use this optionalparameter to specify the idealwidth of the table. If less spacethan this is available, thecolumns are fixed:
Value(MOD_PARAM_VALUE)
Character string You can enter either a number(300, for example) or aJ avaScript variable.
Normally, the width of the webbrowser window is used(document.body.clientWidth).
Example with width 50% of the width of the web browser window
Height (Optional)
Parameter Value DescriptionName/Expression(MOD_PARAM_NAME)
HEIGHT You can use this optionalparameter to specify the idealheight of the table. If lessspace than this is available,the rows are fixed:
Value(MOD_PARAM_VALUE)
Character string You can enter either a number(300, for example) or aJ avaScript variable.
Normally, the height of theweb browser window is used(document.body.clientHeight).
Example with height of the web browser window
Column (Optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
COLUMN You can use this parameter tospecify the last fixed column.
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
41/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 41
The Set Column Width moduledescribes the possible optionsfor specifying a column as aparameter.
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
Row (Optional)Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
ROW You can use this parameter tospecify the last fixed row.
The Set Column Width moduledescribes the possible optionsfor specifying a row as aparameter.
Note that parameter COLUMNmust be replaced with ROW.
More information:
Example: Set Column WidthModule [Seite 13]
Value(MOD_PARAM_VALUE)
Boolean Active
Example with rows fi xed up to row with index 5
Limit for Error Message (Optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
LIMIT_ERROR This optional parameterenables you to specify a limit.If the number of rows exceedsthe limit, an error message isdisplayed. The rows andcolumns are not fixed.
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
42/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 42
Wert (MOD_PARAM_VALUE) Integer The default setting for the limitis 10,000.
Example with erro r message after limit of 1,000 cells is exceeded
Limit for Warning Message (Optional)
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
LIMIT_WARNING This optional parameterenables you to specify a limit.If the number of rows exceedsthe limit, a warning message isdisplayed. The rows andcolumns are fixed until the limitfor the error message isreached.
Value(MOD_PARAM_VALUE) Integer The default setting for the limitis 3,000.
Example with warn ing message after limi t of 500 cells is exceeded
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
43/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 43
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. Forperformance reasons, images can be stored on a web server if the large number of imagesmakes it unpractical to store them in knowledge management.
The images are embedded using URLs. The URLs are formed dynamically according to thefollowing formula:
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 thereforerecommend displaying the characteristic value as a key. The key is unique,
meaning that the file names are unique too.
Example of a Composi te 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. Thefollowing 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 specifiedfor this particular characteristic.
You require a fixed column width for the optimum display ofdocument content. You can use the Width parameter to set thewidth of the columns with document content. You need to set thecolumn width for all other columns too. You can use the Column
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
44/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 44
Width module to do this. We recommend that you specify bothmodules 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 willnot be displayed.
The following section describes the various options offered in this module. The options arespecified as parameters in the parameter list (MOD_PARAMETER_LIST). A parameter ismade 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 inthe column selected. The URLfor the images is determineddynamically from the cellcontent.
Value
(MOD_PARAM_VALUE)
Boolean Active
Example
URL Prefix
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
IMAGE_URL_PREFIX This parameter contains thefirst part of the compositeURL.
Value(MOD_PARAM_VALUE)
Character string Web protocol, host name, portand path
Example with host name and path to the MIME reposit ory as URL prefix
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
45/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 45
URL Suffix
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
IMAGE_URL_SUFFIX This parameter contains thefile extension from the images.
Value
(MOD_PARAM_VALUE)
Character string File extension
Example with .jpg as URL suffix
Example with Display Images Module
The example shows images from the web serverhttp://hostanme:1080/sap/bw/mime/customer/images/products/ with file extension .jpg. Theimages are displayed in the column for characteristic Product (0D_PH2). The column has theheader 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.
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
46/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 46
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
47/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 47
Example: Planning Module
Definition
The Planning module (com. sap. i p. bi . r i g. Pl anni ng) contains the following
enhancements for planning applications in BEx Web: Copy and paste
Select entire cell content by clicking
J ump 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 J avaScript functions to be able to copy andpaste.
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 cells content. This means that you canclick a cell and overwrite the contents immediately.
The function Jump to the next cell by pressing the Enter key is an enhancement that enablesyou to enter data in multiple cells. Pressing the Enter key closes the current cell and selectsthe next cell. Using the option NEXT_CELL_ROW_FIRST, you can specify whether thesystem 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. i p. bi . r i g. Pl anni ng.
Note that access to the clipboard is deactivated by default in many Webbrowsers 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_J avaScript_access_to_the_clipboard)
More information:
Using Modifications [Seite 8]
Make sure that the module is activated. Otherwise the planning enhancementswill not be available.
Example: Planning Module
http://msdn.microsoft.com/en-us/library/bb250473(VS.85).aspxhttp://support.microsoft.com/kb/224993http://kb.mozillazine.org/Granting_JavaScript_access_to_the_clipboardhttp://kb.mozillazine.org/Granting_JavaScript_access_to_the_clipboardhttp://support.microsoft.com/kb/224993http://msdn.microsoft.com/en-us/library/bb250473(VS.85).aspx -
7/22/2019 Analysis Web Item Parameter Modification - Part 1
48/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 48
All three functions are activated by default. You can deactivate individual enhancements asrequired 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 todeactivate the Copy and Pastefunction.
Value(MOD_PARAM_VALUE)
Boolean Active
Example: Deactivating the Copy and Paste function
Deactivate Paste and Overwrite
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
DISABLE_PASTE_OVERWRITE
By default, the J avaScriptfunction Paste(sapbi _r i g_cp_past e_cl ipboard) keeps overwritingrows and columns until all thedata in the clipboard has beenpasted (even if the selectedpaste area is smaller thanrequired). This parameter
deactivates this behavior.
Value(MOD_PARAM_VALUE)
Boolean Active
Example: Deactivating paste and overwrite
Deactivating Select Cell Content
Parameter Value DescriptionName/Expression(MOD_PARAM_NAME)
DISABLE_SELECT_ON_CLICK This parameter deactivatesthe function that selects thecell content when you click ona cell.
Value(MOD_PARAM_VALUE)
Boolean Active
Example: Deactivating Select Cell Content
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
49/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 49
Deactivating Jump By Pressing Enter
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
DISABLE_NEXT_CELL_ON_RETURN
This parameter deactivatesthe function that enables youto jump to the next cell bypressing the Enter key.
Value(MOD_PARAM_VALUE)
Boolean Active
Example: Deactivating Jump By Pressing Enter
Jumping to the Next Cell by Pressing the Enter Key
Parameter Value Description
Name/Expression(MOD_PARAM_NAME)
NEXT_CELL_ROW_FIRST This parameter specifieswhich direction the systemsearches in, to find the nextinput-ready cell to be selected.By default, the systemsearches for a cell in the samerow (to the right of the currentcolumn). The parameterchanges this behavior so thatthe system searches for aninput-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
-
7/22/2019 Analysis Web Item Parameter Modification - Part 1
50/51
SAP Online Help 31.05.2010
Analysis Web Item: Using Parameter Modification 50
Example: Copy and Paste Module
Definition
The Copy and Paste module (com. sap. i p. bi . r i g. CopyPast e) inserts three J avaScript
functions into the Web template. These J avaScript functions enable you to copy and pastetext in theAnalyse Web item. Text can only be pasted into input-ready cells (planning).
You can select a cell in theAnalysis 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 theAnalysis Web item.
It is not possible to select cells using the Row Selection (SELECT_ROWS) parameter in theAnalysis Web item.
The technical name of the implementation is com. sap. i p. bi . r i g. CopyPast e.
You can choose from the following J avaScript functions:
You can call these J avaScript 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 frommultiple columns, the contents of the columns are separated by a tab character. If cellsare 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 theclipboard. Cells that are not input-ready cells are ignored. However, these non-input-ready 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 Webbrowsers 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_J avaScript_access_to_the_clipboard)More information:
Using Modifications [Seite 8]
Make sure that the module is activated. Otherwise the J avaScript functions forcopying and pasting will not be available.
http://msdn.microsoft.com/en-us/library/bb250473(VS.85).aspxhttp://support.microsoft.com/kb/224993http://kb.mozillazine.org/Granting_JavaScript_access_to_the_clipboardhttp://kb.mozillazine.org/Granting_JavaScript_access_to_the_clipboardhttp://support.microsoft.com/kb/224993http://msdn.microsoft.com/en-us/library/bb250473(VS.85).aspx -
7/22/2019 Analysis Web Item Parameter Modification - Part 1
51/51
SAP Online Help 31.05.2010
Example: Copy and Paste Module
Example: Buttons that call the JavaScript functions