Analysis Web Item Parameter Modification - Part 1.pdf

Analysis Web Item: UsingParameter Modification

HE

LP

.BW

_IN

TE

RN

AL

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 bechanged 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 IBMCorporation.

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.

Java is a registered trademark of Sun Microsystems, Inc.

JavaScript 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



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



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 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 of SAP 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 aprogramming language when they are surrounded by body text, forexample, SELECT and INCLUDE.

Example text 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.



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 ModificationUseIf you do not want to use the default display and behavior of the Analysis Web item, you canuse 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.

PrerequisitesThe 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.0does not support any customer modifications or extensions to Java coding. Customers aretherefore 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 displayand behavior of these modules.

Note that the modification modules use and manipulate the standardimplementation of the Analysis 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.

ProcedureYou 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-specificparameters.

More information: Using Modifications [Seite 8]

ResultThe 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 fortable cells.

ExampleFor 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]



Using ModificationsUseIn Web item Analysis, modifications allow you to influence how items are displayed and howthey 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. The Active parameter can be used to active anddeactivate modules at runtime.

The default value for parameter Active 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 under Examples of Modules [Seite 12].

StructureThe 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 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 onesingle module.

Module List (MOD_MODULE_LIST) This selection makes it possible to specify a listof single modules. The modules are called inthe 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




Alias (MOD_ALIAS) The Alias 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) The Active parameter defines whether amodule is active or not. If it is not active, thetable 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 aredisplayed (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


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


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.



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_OBJECT_ATTRIBUTE)

? Data Cell (DATA_CELL)? Array (MOD_VALUE_ARRAY)

Selecting a type makes specific input helppossible for each type.

If Action is selected, the command wizardstarts. If Data Provider is 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).



Examples of ModulesThis section contains a list with descriptions of the modules that you can use to personalizethe display and behavior of the Analysis Web item.

Column Width moduleYou 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 moduleYou 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 moduleYou 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 moduleYou can use this module to make input-enabled cells non input-enabled.

More information: Example: Empty Cells as Non Input-Enabled Module [Seite 27]



Example: Column Width ModuleDefinitionThe Column Width module (com.sap.ip.bi.rig.ColumnWidth) enables thedefinition of the column width in the Analysis 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) or Row (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 widthfor 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)



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.

Default widthThe 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 notvisible.

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 columnsThe default width for fixed columns is used for characteristic and key figure columns in thedrilldown.

Default width for fixed columns



COLUMN_FIX

COLUMN_FIX[*]

COLUMN_FIX_DEFAULT

Default column



Default width for specific indexThe 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





COLUMN[]

COLUMN_

is the column. Thefirst column has index 1.




Blank Leave Placeholder List blank.

Example for column width of 100 for column with index 5 and index 6

is the sequentialnumber.




Type = integer, value =

is the column. Thefirst column has index 1.

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.



Default width for specific characteristicThe 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



COLUMN[]

COLUMN_< number >





Type = characteristic, value =

is thetechnical name of thecharacteristic.

Example for column width of 200 for product characteristic (0D_PH2)

Default width for specific characteristic valueThe 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



COLUMN[]

COLUMN_< number >





Types Characteristic Valueand Value consisting of and

is thetechnical name of thecharacteristic and isthe technical characteristicvalue

Example for column width of 200 for characteristic value PDS12 of the characteristicproduct (0D_PH2)



Default width for specific attributeThe 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



COLUMN[]

COLUMN_< number >





Type = attribute, value =

is the technicalname of the attribute.

Example for column width of 200 for price attribute (0D_PREIS)

Default width for specific memberThe 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 UIDin 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



COLUMN[]

COLUMN_< number >





Type = structure member,value =

is thetechnical name of the structuremember (key figure).

Example for column width of 150 for key figure



Continuous text with automatic line breaks (optional)



WRAPPING Using this parameter, you canspecify whether the headersare displayed as continuoustext. Line breaks areautomatically added to thecontinuous text.


Boolean Active

Example: automatic line breaks in headers

Continuous text for all lines (optional)



ALL_ROWS_WRAPPING Using this parameter, you canspecify whether all lines aredisplayed as continuous text.Line breaks are automaticallyadded to the continuous text.


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



Example: Negative Number ModuleDefinitionThe Negative Number module (com.sap.ip.bi.rig.NegativeNumber) depictsnegative numbers in a column or entire table in red. Other types of formatting are notcurrently supported.

The technical name of the implementation iscom.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.



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.


Boolean Active

Example for formatted negative numbers in the column with index 3



Example: Document Content ModuleDefinitionThe Document Content module (com.sap.ip.bi.rig.DocumentContent)enables the display of document content in a cell in the Analysis Web item. The documentscan be displayed as comments (text only), images and links.

The technical name of the implementation iscom.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 parameters Action Open Document and Action Create Comment simplify userinteraction. 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:


Using Modifications [Seite 8]

Make sure that the module is activated. Otherwise, the document content willnot be displayed.

Example for Column Width and Document Content modules





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:



If you do not specify the Placeholder List parameter, you can ignore the parameters listedhere.

Displaying CommentsYou 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).



DISPLAY_TEXT_PLAIN The selected column displaysthe content of comments.Comments are unformattedtext. Only the first comment ina cell is shown.


Boolean Active

Example

Displaying ImagesYou 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).



DISPLAY_IMAGE Any documents that areimages are displayed in theselected column. Only the firstimage in a cell is shown.


Boolean Active



Example

Displaying LinksYou 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).



DISPLAY_LINK The documents are displayedas links in the selectedcolumn. All the documents of acell are shown as links withinthe relevant cell.


Boolean Active

Example

ColumnYou must specify a column.



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

WidthIt is recommended that you specify a column width because the default column width isusually too narrow for displaying documentation contents.





WIDTH Width of column in which todisplay document content.



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.



HEIGHT Height of row in whichdocument content isdisplayed.


Integer Height in pixels

Example with Row Height 100

Action: Open Document (optional)Parameter Value Description


ACTION_OPEN_ON_CLICK If a document exists for a cell,a dialog box opens when youclick on the cell. This dialogbox displays the documentand also contains thefunctionality of the Web Itemlist of documents. Moreinformation: List of Documents[Extern]


Boolean Active

Example for Action Document Open, if document exists

Action: Create Comment (optional)Parameter Value Description


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.




Boolean Active

Example for Create Action Comment, if no document exists

Alignment (Optional)Parameter Value Description


ALIGNMENT Alignment


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.



CAPTION Column heading


Character string Text


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.



RESULT Display documents in resultsrows


Boolean Active

Example for Create Action Comment, if no document exists



Maximum Length of Document Content (optional)Parameter Value Description


MAX_CONTENT_LENGTH Maximum length of documentcontent after which any furthercontent is truncated. The factthat content is truncated isindicated by ....


Integer Length in characters

Example for limit of 1000 characters

Correction for Character Set (optional)Parameter Value Description


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.


Integer Positive or negative correctionto correct the character width.

Example for larger character set with correction of 2



Example: Empty Cells as Non Input-EnabledModuleDefinitionUsing 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





Column (Optional)

If no columns are specified, the negative numbers are formatted in all columns.



COLUMN Using this parameter you canspecify the column containingthe empty cells that you dontwant to set to input-enabled.

The Set Column Width module



describes the possible optionsfor specifying a column as aparameter.

More information: Example:Column Width Module [Seite13]


Boolean Active

Example with non input-enabled empty cells in column with index 3



Example: Own Symbols for Exception ModuleDefinitionThe 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_9If 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 Item Analysis. The maindifference is the background color.

Exception Display with Background ColorIf 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 ColorIf parameter Exception Display has the value Symbol (SYMBOL), Symbol and Text(SYMBOL_TEXT) or Text and Symbol (TEXT_SYMBOL), the cells are displayed withoutbackground 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







If you do not specify the Placeholder List parameter, you can ignore this parameter.

Symbols for Three-Level Alert LevelsEither the parameters for the three-level alert levels or the nine-level alert levels (see nextparameter) need to be specified .



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.


Image URL or path in the MIMERepository:

Example of a symbol from the MIME repository

Symbols for Nine-Level Alert LevelsEither the parameters for the three-level alert levels (see previous parameter) or the nine-level alert levels need to be specified



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 toset symbols for all nine alertlevels.

? ALERT_1 equates toGood 1





? ALERT_4 equates toCritical 1



? ALERT_7 equates toBad 1




Image URL or path in the MIMERepository:

Example of a symbol from the MIME repository

Column (optional)

If no columns are specified, your own symbols are used for exceptions in all columns.



COLUMN You use this parameter tospecify the column whoseexceptions you want toreplace with your ownsymbols.

The Set Column Width moduledescribes the possible optionsfor specifying a column as aparameter. More information:Example: Column WidthModule [Seite 13]


Boolean Active

Example for displaying document content in column with index 3

Alignment (Optional)Parameter Value Description


ALIGNMENT Alignment

Value Character string Possible values are:



(MOD_PARAM_VALUE) Left (LEFT)

Centered (CENTER)

Right (RIGHT)



Height (Optional)Parameter Value Description


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.


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 Color is 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.



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.


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 background color



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.



SEPARATOR You 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



Example: Format Cells ModuleDefinitionThe Format Cells module (com.sap.ip.bi.rig.Format) enables you to specificallyformat 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. Cellscan be specified in three ways:

? Cell type? Column? Row

These three options can be combined, for example to format a particular cell (combination ofcolumn 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 an Analysis Web Item to format various cells.

The technical name of the implementation is com.sap.ip.bi.rig.Format.More information:


Make sure that the module is activated. Otherwise, the formatting will not bedisplayed.

Example: Format Cells Types Module







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 typeParameter Value Description


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 typeshere can beselected toformat thecorrespondingcells.ParameterCELL_DEBUGdisplays thecell type of allcells.


Boolean Active

Example with formatting for cell type CELL_HEADER

ColumnParameter Value Description


COLUMN You can use this parameter tospecify the column with thecells to be formatted.The Set Column Width moduledescribes the options for



specifying a column as aparameter.More information:Example: Set Column WidthModule [Seite 13]


Boolean Active

Example with formatting in column 1 with index 3

RowParameter Value Description


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]


Boolean Active

Example with formatting in row with index 5

Text Color (Optional)Parameter Value Description


COLOR You can use this parameter toselect the text color.


Character string The color can be specifiedeither as a hexadecimal valueor as a color name.

Example with dark-green text color



Background Color (Optional)Parameter Value Description


BACKGROUND_COLOR You can use this parameter toselect the background color.


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


BOLD You can use this parameter toset bold text.


Boolean Active

Example

Italic Text (Optional)Parameter Value Description


ITALIC You can use this parameter toactivate italic text.


Boolean Active

Example

Horizontal Alignment (Optional)Parameter Value Description


ALIGNMENT Horizontal Alignment


Character string Possible values are:? Left (LEFT)? Centered (CENTER)? Right (RIGHT)


Example



Vertical Alignment (Optional)Parameter Value Description


VERTICAL_ALIGNMENT Vertical Alignment


Character string Possible values are:Top (TOP)Centered (CENTER)Bottom (BOTTOM)The default value is Centered.

Example

Display Cell Types (Optional)Parameter Value Description


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.


Boolean Active

Example



Example: Fix Rows and Columns ModuleDefinitionThe Fix Rows and Columns module (com.sap.ip.bi.rig.Scrolling) allows youto fix the header rows and leading columns in Web Item Analysis.

The header rows contain the column headers. The leading columns normally contain thecharacteristics.

The ideal height and width of Web Item Analysis can be specified as a value or JavaScriptvariable. The JavaScript 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 Item Analysis 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







If you do not specify the Placeholder List parameter, you can ignore the parameters listedhere.

Width (Optional)Parameter Value Description


WIDTH You can use this optionalparameter to specify the idealwidth of the table. If less spacethan this is available, thecolumns are fixed:


Character string You can enter either a number(300, for example) or aJavaScript 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 Description


HEIGHT You can use this optionalparameter to specify the idealheight of the table. If lessspace than this is available,the rows are fixed:


Character string You can enter either a number(300, for example) or aJavaScript 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


COLUMN You can use this parameter tospecify the last fixed column.



The Set Column Width moduledescribes the possible optionsfor specifying a column as aparameter.

More information:

Example: Set Column WidthModule [Seite 13]


Boolean Active

Example with the column for of characteristic Product (0D_PH2) fixed

Row (Optional)Parameter Value Description


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]


Boolean Active

Example with rows fixed up to row with index 5

Limit for Error Message (Optional)Parameter Value Description


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.



Wert (MOD_PARAM_VALUE) Integer The default setting for the limitis 10,000.

Example with error message after limit of 1,000 cells is exceeded

Limit for Warning Message (Optional)Parameter Value Description


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.


Integer The default setting for the limitis 3,000.

Example with warning message after limit of 500 cells is exceeded



Example: Display Images ModuleDefinitionThe Display Images module (com.sap.ip.bi.rig.DocumentContent) enablesyou 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 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. 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



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]



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:




Displaying ImagesParameter Value Description


DISPLAY_IMAGE_URL The images are displayed inthe column selected. The URLfor the images is determineddynamically from the cellcontent.


Boolean Active

Example

URL PrefixParameter Value Description


IMAGE_URL_PREFIX This parameter contains thefirst part of the compositeURL.


Character string Web protocol, host name, portand path

Example with host name and path to the MIME repository as URL prefix



URL SuffixParameter Value Description


IMAGE_URL_SUFFIX This parameter contains thefile extension from the images.


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.



Example: Planning ModuleDefinitionThe Planning module (com.sap.ip.bi.rig.Planning) contains the followingenhancements 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 andpaste.

If the function Select entire cell content by clicking is activated, clicking on a cell not onlyplaces 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.ip.bi.rig.Planning.

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_JavaScript_access_to_the_clipboard)

More information:


Make sure that the module is activated. Otherwise the planning enhancementswill not be available.

Example: Planning Module



All three functions are activated by default. You can deactivate individual enhancements asrequired by using the following options.

Deactivating Copy and Paste



DISABLE_COPY_PASTE You can use this parameter todeactivate the Copy and Pastefunction.


Boolean Active

Example: Deactivating the Copy and Paste function

Deactivate Paste and Overwrite



DISABLE_PASTE_OVERWRITE

By default, the JavaScriptfunction Paste(sapbi_rig_cp_paste_clipboard) keeps overwritingrows and columns until all thedata in the clipboard has beenpasted (even if the selectedpaste area is smaller thanrequired). This parameterdeactivates this behavior.


Boolean Active

Example: Deactivating paste and overwrite

Deactivating Select Cell Content



DISABLE_SELECT_ON_CLICK This parameter deactivatesthe function that selects thecell content when you click ona cell.


Boolean Active

Example: Deactivating Select Cell Content



Deactivating Jump By Pressing Enter



DISABLE_NEXT_CELL_ON_RETURN

This parameter deactivatesthe function that enables youto jump to the next cell bypressing the Enter key.


Boolean Active

Example: Deactivating Jump By Pressing Enter

Jumping to the Next Cell by Pressing the Enter Key



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).


Boolean Active

Example: Jumping to the Next Cell by Pressing the Enter Key



Example: Copy and Paste ModuleDefinitionThe Copy and Paste module (com.sap.ip.bi.rig.CopyPaste) inserts three JavaScriptfunctions into the Web template. These JavaScript functions enable you to copy and pastetext 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 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.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_clipboardThe 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_clipboardThe 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_clearThe 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_JavaScript_access_to_the_clipboard)

More information:


Make sure that the module is activated. Otherwise the JavaScript functions forcopying and pasting will not be available.



Example: Copy and Paste Module

Example: Buttons that call the JavaScript functions

Analysis Web Item Parameter Modification - Part 1.pdf

Documents

Transcript of Analysis Web Item Parameter Modification - Part 1.pdf