Analysis Web Item: Using Parameter Modification HELP.BW_INTERNAL

Transcription

1 Analysis Web Item: Using Parameter Modification HELP.BW_INTERNAL

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 purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iseries, pseries, xseries, zseries, eserver, z/vm, z/os, i5/os, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, Clear Enterprise, SAP BusinessObjects Explorer and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP France in the United States and in other countries. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or Analysis Web Item: Using Parameter Modification 2

3 omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty Analysis Web Item: Using Parameter Modification 3

4 Icons in Body Text Icon Meaning Caution Example Note Recommendation Syntax Additional icons are used in SAP Library documentation to help you identify different types of information at a glance. For more information, see Help on Help General Information Classes and Information Classes for Business Information Warehouse on the first page of any version of SAP Library. Typographic Conventions Type Style Example text Example text EXAMPLE TEXT Example text Example text <Example text> EXAMPLE TEXT Description Words or characters quoted from the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options. Cross-references to other documentation. Emphasized words or phrases in body text, graphic titles, and table titles. Technical names of system objects. These include report names, program names, transaction codes, table names, and key concepts of a programming language when they are surrounded by body text, for example, SELECT and INCLUDE. Output on the screen. This includes file and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools. Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation. Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system. Keys on the keyboard, for example, F2 or ENTER. Analysis Web Item: Using Parameter Modification 4

5 Analysis Web Item: Using Parameter Modification... 6 Using Modifications... 8 Examples of Modules Example: Column Width Module Example: Negative Number Module Example: Document Content Module Example: Empty Cells as Non Input-Enabled Module Example: Own Symbols for Exception Module Example: Format Cells Module Example: Fix Rows and Columns Module Example: Display Images Module Example: Planning Module Example: Copy and Paste Module Analysis Web Item: Using Parameter Modification 5

6 .. SAP Online Help Use Analysis Web Item: Using Parameter Modification If you do not want to use the default display and behavior of the Analysis Web item, you can use the Modification parameter to change them. You can modify the table structure and the table cells. The Modification parameter provides modules whose use can be controlled using additional parameters. This function enables you to use similar options to those available in earlier releases with the Web Design API for Tables. Unlike the Web Design API for Tables, modifications enable you to make targeted changes to the display and behavior without any programming. Prerequisites The modules are the main prerequisites for making modifications to the Analysis Web item. The modules are implemented in Java. The SAP Basis infrastructure in SAP NetWeaver 7.0 does not support any customer modifications or extensions to Java coding. Customers are therefore not able to develop their own modules for modifications to the Analysis Web item. SAP delivers a number of sample modules. You can use parameters to modify the display and behavior of these modules. Procedure Note that the modification modules use and manipulate the standard implementation of the Analysis Web item. This may mean that specific requirements are not met. SAP tries to eliminate any potential problems. However, situations can occur that require the standard implementation to be modified. This type of modification is not possible in every case. Therefore the modules are only described as examples. The modules can be used productively. However, you are not entitled to assistance from SAP support. You use the modules as follows: 1. Select a module from the sample modules. 2. Specify the module in the Modification parameter of the Analysis Web item. 3. Control the display and behavior of the module by specifying the module-specific parameters. More information: Using Modifications [Seite 8] Result The table of the Analysis Web item is displayed in an individual manner using the modules. The behavior of the table may also be different. For example, you can define commands for table cells. Example For example, you can define a fixed column width or display comments in cells. More information: Example: Set Column Width Module [Seite 13] Example: Document Content Module [Seite 21] Analysis Web Item: Using Parameter Modification 6

7 Analysis Web Item: Using Parameter Modification 7

8 Use Using Modifications In Web item Analysis, modifications allow you to influence how items are displayed and how they behave using modules. You enter the modules using the Modification (MODIFICATION) parameter. If you are using more than one module, follow the sequence of the modules. Changed rows are passed on to subsequent modules for further processing. A module is only called if it is active. The Active parameter can be used to active and deactivate modules at runtime. The default value for parameter Active is inactive, meaning that that module will not be called. Activate the parameter by specifying a module. You can specify the modules for an output format so that the change in behavior only affects output in HTML, for example, and not output in PDF. You can find a list of possible modules under Examples of Modules [Seite 12]. Structure The parameters that a module can have depend on the module: The documentation for the modules describes which parameters are supported and their meaning. The following is a general description of the parameters. Modification Parameter Modification (MODIFICATION) None (NONE) Single Module (MOD_SINGLE_MODULE) Module List (MOD_MODULE_LIST) Description You can use this parameter to specify one more modules that change the display or behavior of Web item Analysis. Possible values: None (NONE) Single Module (MOD_SINGLE_MODULE) Module List (MOD_MODULE_LIST) The default value is to use no modifications. This selection makes it possible to specify one single module. This selection makes it possible to specify a list of single modules. The modules are called in the specified sequence, meaning that subsequent modules modify existing cells. This means for example that the column widths can be defined first, and that comments can then be displayed in a given column. Single Module Parameter Description Analysis Web Item: Using Parameter Modification 8

9 Alias (MOD_ALIAS) Active (ACTIVE) Formats (MOD_TARGETS) Type (MOD_SELECT) The Alias parameter makes it possible to enter a name. The name is displayed in the Web item parameters and simplifies identification of a module. The alias is particularly important for the Set Status of Module [Extern] command if several modules are being used. The Active parameter defines whether a module is active or not. If it is not active, the table is not modified. You can use this parameter and the Set Status of Module [Extern] command to activate or deactivate a modification at runtime. You use this parameter to define the formats for which the module is called. All (ALL) Selections (MOD_CLIENT_SELECTION) If you choose Selections, all formats are displayed (HTML, PDF or CSV, for example). Each format can be activated individually. This means that a modification can only be used in certain formats. This parameter always has the value Generic Module (MOD_GENERIC_MODULE). The details of this parameter are described below. Generic Module Parameter Name of the Implementation (MOD_REFERENCE) Parameter List (MOD_PARAMETER_LIST) Description You use this parameter to specify the technical name of the module. You can find a list of possible values under Examples of Modules [Seite 12]. The parameter list contains one or more parameters (PARAMETER). The parameters that can be used depends on the chosen module: The parameters are generic and can be used flexibly. Selecting the type makes specific input help possible. The details for a parameter are described below. Parameter Parameter Description You use this parameter to specify the technical name of a parameter. You can find the possible values in the documentation for the individual modules. As well as technical names, modules can support simple expressions. Analysis Web Item: Using Parameter Modification 9

10 The value of a parameter has a certain type. Depending on this type, a value can be specified. The following types are supported: None (NONE) String (STRING) Boolean (BOOLEAN) Integer (INTEGER) Image (IMAGE) Action (ACTION) Data Provider (DATA_PROVIDER_REF) Characteristic (CHARACTERISTIC) Characteristic (CHARACTERISTIC_MEMBER) Structure (STRUCTURE) Structure (STRUCTURE_MEMBER) Attribute Name (INFO_OBJECT_ATTRIBUTE) Data Cell (DATA_CELL) Array (MOD_VALUE_ARRAY) Selecting a type makes specific input help possible for each type. If Action is selected, the command wizard starts. If Data Provider is selected, all data providers in the Web template are displayed. Placeholder List (MOD_PLACEHOLDER_LIST) In some cases, the generic input help does not provide the required values. Whenever this happens, you need to enter the technical name manually. You can use Query Designer to find the technical names of structures, structural components and so on. With some modules, it is necessary to specify more than one value. You can use the placeholder list to do this. The parameter can contain placeholders that are replaced with the values in the placeholder list. The values in the placeholder list also have a type. The available types are described under the parameter. Analysis Web Item: Using Parameter Modification 10

11 Analysis Web Item: Using Parameter Modification 11

12 Examples of Modules This section contains a list with descriptions of the modules that you can use to personalize the display and behavior of the Analysis Web item. Column Width module You use this module to define the width of individual columns in the Analysis Web item. More information: Example: Column Width Module [Seite 13] Negative Number module You use this module to display negative numbers in a column or in the entire table in red. More information: Example: Negative Number Module [Seite 19] Document Content module You use this module to display document content in a cell in the Analysis Web item. More information: Example: Document Content Module [Seite 21] Empty Cells as Non Input-Enabled module You can use this module to make input-enabled cells non input-enabled. More information: Example: Empty Cells as Non Input-Enabled Module [Seite 27] Analysis Web Item: Using Parameter Modification 12

13 Definition Example: Column Width Module The Column Width module (com.sap.ip.bi.rig.columnwidth) enables the definition of the column width in the Analysis Web item. There are several possibilities for specifying the columns: Default width Default width for fixed columns Default width for specific index Default width for specific characteristic Default width for specific characteristic value Default width for specific attribute Default width for specific structure member (key figure or characteristic value) The technical name of the implementation iscom.sap.ip.bi.rig.columnwidth. Other modules (e.g. documentation contents) can also have the parameter Column (COLUMN) or Row (ROW). The possibilities available here for entering a column are the same as for the module Set Column Width. Note that the value might be Boolean rather than an integer. All columns that are not explicitly specified have the default width. If you do not specify a default width, all columns that are not explicitly specified have the width 0. This means that they are not visible. The column widths for a specific characteristic, attribute, or structure value overwrite the width for a specific index and the default widths. An index width overwrites the default widths. If you specify multiple columns, you have to change the names of the parameters. The COLUMN parameter name must be different for each column. You must therefore add a number to the names. There are the following supported ways of doing this: COLUMN[<number>] COLUMN_<number> Example Make sure that the module is activated. If not, the column widths do not change. <bi:analysis_item name="analysis_item_1" designwidth="400" designheight="200" > <bi:data_provider_ref value="dp_1" /> <bi:modification type="choice" value="mod_single_module" > <bi:mod_single_module type="composite" > <bi:active value="x" /> <bi:mod_select type="choice" value="mod_generic_module" > <bi:mod_generic_module type="composite" > <bi:mod_reference value="com.sap.ip.bi.rig.columnwidth" /> <bi:mod_parameter_list type="orderedlist" > <bi:mod_parameter type="composite" index="1" >... (add parameter here, see below for details) Analysis Web Item: Using Parameter Modification 13

14 </bi:mod_parameter> </bi:mod_parameter_list> </bi:mod_generic_module> </bi:mod_select> </bi:mod_single_module> </bi:modification> </bi:analysis_item> The following section describes the various options offered in this module. The options are specified as parameters in the parameter list (MOD_PARAMETER_LIST). A parameter is made up of the following elements: Placeholder List (MOD_PLACEHOLDER_LIST) If the Placeholder List parameter is not specified, you can ignore this parameter. Default width The default width is important because it is used for all non-specified columns. If you do not specify a default width, all non-specified columns are set to 0, which means that they are not visible. Default width COLUMN[*] COLUMN_DEFAULT Integer Default column Width in pixels Example for default width of 50 <bi:mod_param_name value="column_default" /> <bi:mod_param_value type="choice" value="integer" > <bi:integer value="50" /> Default width for fixed columns The default width for fixed columns is used for characteristic and key figure columns in the drilldown. Default width for fixed columns COLUMN_FIX COLUMN_FIX[*] COLUMN_FIX_DEFAULT Integer Default column Width in pixels Default width for specific index The column is identified by the specified index. The width of the specified column is set independently of the current navigational state. If the navigational state changes, the content of the specified column might relate to a different characteristic or key figure. Default width for specific index Analysis Web Item: Using Parameter Modification 14

15 Placeholder List (MOD_PLACEHOLDER_LIST) COLUMN[<index>] COLUMN_<index> Integer Blank <Index> is the column. The first column has index 1. Width in pixels Leave Placeholder List blank. Example for column width of 100 for column with index 5 and index 6 <<bi:mod_param_name value="column[5]" /> <bi:mod_param_value type="choice" value="integer" > <bi:integer value="100" /> <bi:mod_param_name value="column[6]" /> <bi:mod_param_value type="choice" value="integer" > <bi:integer value="100" /> Example with a different syntax <bi:mod_param_name value="column_5" /> <bi:mod_param_value type="choice" value="integer" > <bi:integer value="100" /> <bi:mod_param_name value="column_6" /> <bi:mod_param_value type="choice" value="integer" > <bi:integer value="100" /> Alternative specification of index using placeholder list Placeholder List (MOD_PLACEHOLDER_LIST) COLUMN[<number>] COLUMN_< number > Integer Type = integer, value = <index> <number> is the sequential number. Width in pixels <Index> is the column. The first 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. <bi:mod_param_name value="column_1" /> <bi:mod_param_value type="choice" value="integer" > <bi:integer value="100" /> <bi:mod_placeholder_list type="orderedlist" > <bi:mod_param_value type="choice" index="1" value="integer" > <bi:integer value="5" /> </bi:mod_placeholder_list> <bi:mod_param_name value="column_2" /> <bi:mod_param_value type="choice" value="integer" > <bi:integer value="100" /> <bi:mod_placeholder_list type="orderedlist" > <bi:mod_param_value type="choice" index="1" value="integer" > <bi:integer value="6" /> </bi:mod_placeholder_list> Analysis Web Item: Using Parameter Modification 15

16 Default width for specific characteristic The column is determined by the specification of a characteristic. The column with the specified characteristic is always modified in line with the specified width. This is independent of the navigational state. Default width for specific characteristic Placeholder List (MOD_PLACEHOLDER_LIST) COLUMN[<number>] COLUMN_< number > Integer Type = characteristic, value = <characteristic> <number> is the sequential number. Width in pixels <characteristic> is the technical name of the characteristic. Example for column width of 200 for product characteristic (0D_PH2) <bi:mod_param_name value="column_1" /> <bi:mod_param_value type="choice" value="integer" > <bi:integer value="200" /> <bi:mod_placeholder_list type="orderedlist" > <bi:mod_param_value type="choice" index="1" value="characteristic" > <bi:characteristic value="0d_ph2" text="0d_ph2" /> </bi:mod_placeholder_list> Default width for specific characteristic value The column is determined by the specification of a characteristic with a characteristic value. The column with the specified characteristic value is always modified in line with the specified width. This is independent of the navigational state. Default width for specific characteristic value Placeholder List (MOD_PLACEHOLDER_LIST) COLUMN[<number>] COLUMN_< number > Integer Types Characteristic and consisting of <characteristic> and <value> <number> is the sequential number. Width in pixels <characteristic> is the technical name of the characteristic and <value> is the technical characteristic value Example for column width of 200 for characteristic value PDS12 of the characteristic product (0D_PH2) <bi:mod_param_name value="column_1" /> <bi:mod_param_value type="choice" value="integer" > <bi:integer value="200" /> <bi:mod_placeholder_list type="orderedlist" > <bi:mod_param_value type="choice" index="1" value="characteristic_member" > <bi:characteristic_member type="composite" > <bi:characteristic value="0d_ph2" text="0d_ph2" /> <bi:member_name value="pds12" text="pds12" /> </bi:characteristic_member> </bi:mod_placeholder_list> Analysis Web Item: Using Parameter Modification 16

17 Default width for specific attribute The column is determined by the specification of an attribute. The column with the specified attribute is always modified in line with the specified width. This is independent of the navigational state. Default width for specific attribute Placeholder List (MOD_PLACEHOLDER_LIST) COLUMN[<number>] COLUMN_< number > Integer Type = attribute, value = <attribute> <number> is the sequential number. Width in pixels <attribute> is the technical name of the attribute. Example for column width of 200 for price attribute (0D_PREIS) <bi:mod_param_name value="column_1" /> <bi:mod_param_value type="choice" value="integer" > <bi:integer value="200" /> <bi:mod_placeholder_list type="orderedlist" > <bi:mod_param_value type="choice" index="1" value="info_object_attribute" > <bi:info_object_attribute value="0d_preis" /> </bi:mod_placeholder_list> Default width for specific member The column is determined by the specification of a structure member (key figure). The column with the specified structure member (key figure) is always modified in line with the specified width. This is independent of the navigational state. A structure value is generally a key figure. However, it can also be a selection or a formula. You must specify the structure value as a UID. You can find this UID in the BEx Query Designer, in the properties of structure component on the Enhanced tab page. If you assign a technical name in the properties of the BEx Query Designer, you can specify a technical name. Structure value is actually a dropdown box. Press F11 to make the field inputready. You can then insert the technical name of the key figure from the query definition. Default width for specific member Placeholder List (MOD_PLACEHOLDER_LIST) COLUMN[<number>] COLUMN_< number > Integer Type = structure member, value = <structure member> <number> is the sequential number. Width in pixels <structure member> is the technical name of the structure member (key figure). Example for column width of 150 for key figure <bi:mod_param_name value="column_3" /> <bi:mod_param_value type="choice" value="integer" > Analysis Web Item: Using Parameter Modification 17

18 <bi:integer value="150" /> <bi:mod_placeholder_list type="orderedlist" > <bi:mod_param_value type="choice" index="2" value="structure_member" > <bi:structure_member value="45240plo41z7troe321mna46c" text="45240plo41z7troe321mna46c" /> </bi:mod_placeholder_list> Continuous text with automatic line breaks (optional) WRAPPING Boolean Using this parameter, you can specify whether the headers are displayed as continuous text. Line breaks are automatically added to the continuous text. Active Example: automatic line breaks in headers <bi:mod_param_name value="wrapping" /> <bi:mod_param_value type="choice" value="boolean" > Continuous text for all lines (optional) ALL_ROWS_WRAPPING Boolean Using this parameter, you can specify whether all lines are displayed as continuous text. Line breaks are automatically added to the continuous text. Active Note that preparing the continuous text is very time-consuming. Only use this parameter if you really need continuous text. Example: automatic line breaks in all lines <bi:mod_param_name value="all_rows_wrapping" /> <bi:mod_param_value type="choice" value="boolean" > Analysis Web Item: Using Parameter Modification 18

19 Definition Example: Negative Number Module The Negative Number module (com.sap.ip.bi.rig.negativenumber) depicts negative numbers in a column or entire table in red. Other types of formatting are not currently supported. The technical name of the implementation is com.sap.ip.bi.rig.negativenumber. Example Make sure that the module is activated. If not, negative numbers are not formatted. <bi:analysis_item name="analysis_item_1" designwidth="400" designheight="200" > <bi:data_provider_ref value="dp_1" /> <bi:modification type="choice" value="mod_single_module" > <bi:mod_single_module type="composite" > <bi:active value="x" /> <bi:mod_select type="choice" value="mod_generic_module" > <bi:mod_generic_module type="composite" > <bi:mod_reference value="com.sap.ip.bi.rig.negativenumber" /> </bi:mod_generic_module> </bi:mod_select> </bi:mod_single_module> </bi:modification> </bi:analysis_item> The following section describes the various options offered in this module. The options are specified as parameters in the parameter list (MOD_PARAMETER_LIST). A parameter consists of a, and Placeholder List (MOD_PLACEHOLDER_LIST). If you do not specify the Placeholder List parameter, you can ignore this parameter. Column (Optional) If no columns are specified, the negative numbers are formatted in all columns. COLUMN Boolean With this parameter you can specify the column whose negative numbers are formatted. The Set Column Width Module [Seite 13] module describes the possible options for specifying a column as a parameter. Active Example for formatted negative numbers in the column with index 3 <bi:mod_param_name value="column" /> <bi:mod_param_value type="choice" value="boolean" > <bi:mod_placeholder_list type="orderedlist" > <bi:mod_param_value type="choice" index="1" value="integer" > <bi:integer value="3" /> Analysis Web Item: Using Parameter Modification 19

20 </bi:mod_placeholder_list> Analysis Web Item: Using Parameter Modification 20

21 Definition Example: Document Content Module The Document Content module (com.sap.ip.bi.rig.documentcontent) enables the display of document content in a cell in the Analysis Web item. The documents can be displayed as comments (text only), images and links. The technical name of the implementation is com.sap.ip.bi.rig.documentcontent. You require a fixed column width for the optimum display of document content. You can use the Width parameter to set the width of the columns with document content. Note that only the first comment or the first image in a cell is shown. The parameters Action Open Document and Action Create Comment simplify user interaction. If a document exists for a cell, a dialog box opens when you click on the cell. This dialog box displays the document and also contains the functionality of the Web Item list of documents. If no document exists for this cell, you can click on the cell to open a dialog box where you can create a new comment. More information: List of Documents [Extern] You need to set the column width for all other columns too. You can use the Column Width module to do this. We recommend that you specify both modules in the module list. More information: Example: Set Column Width Module [Seite 13] Using Modifications [Seite 8] Make sure that the module is activated. Otherwise, the document content will not be displayed. Example for Column Width and Document Content modules <bi:analysis_item name="analysis_item_1" designwidth="400" designheight="200" > <bi:data_provider_ref value="dp_1" /> <bi:modification type="choice" value="mod_single_module" > <bi:mod_module_list type="orderedlist" > <bi:mod_single_module type="composite" index="1" > <bi:active value="x" /> <bi:mod_select type="choice" value="mod_generic_module" > <bi:mod_generic_module type="composite" > <bi:mod_reference value="com.sap.ip.bi.rig.columnwidth" /> <bi:mod_parameter_list type="orderedlist" > <bi:mod_parameter type="composite" index="1" > </bi:mod_parameter> </bi:mod_parameter_list> </bi:mod_generic_module> </bi:mod_select> </bi:mod_single_module>... (add parameter here, see below for details) <bi:mod_single_module type="composite" index="2" > <bi:active value="x" /> <bi:mod_select type="choice" value="mod_generic_module" > Analysis Web Item: Using Parameter Modification 21

22 <bi:mod_generic_module type="composite" > <bi:mod_reference value="com.sap.ip.bi.rig.documentcontent" /> <bi:mod_parameter_list type="orderedlist" > <bi:mod_parameter type="composite" index="1" >... (add parameter here, see below for details) </bi:mod_parameter> </bi:mod_parameter_list> </bi:mod_generic_module> </bi:mod_select> </bi:mod_single_module> </bi:mod_module_list> </bi:modification> </bi:analysis_item> The section below describes the options offered in this module. These options influence how the module functions and are specified as parameters in the parameter list (MOD_PARAMETER_LIST). A parameter is made up of the following elements: Placeholder List (MOD_PLACEHOLDER_LIST) If you do not specify the Placeholder List parameter, you can ignore the parameters listed here. Displaying Comments You need to choose a document display that allows you to choose between displaying comments, images or links. It is not possible to combine the display of different document types (for example, to display comments and images). DISPLAY_TEXT_PLAIN Boolean The selected column displays the content of comments. Comments are unformatted text. Only the first comment in a cell is shown. Active Example <bi:mod_param_name value="display_text_plain" /> <bi:mod_param_value type="choice" value="boolean" > Displaying Images You need to choose a document display that allows you to choose between displaying comments, images or links. It is not possible to combine the display of different document types (for example, to display comments and images). DISPLAY_IMAGE Boolean Any documents that are images are displayed in the selected column. Only the first image in a cell is shown. Active Analysis Web Item: Using Parameter Modification 22

23 Example <bi:mod_param_name value="display_image" /> <bi:mod_param_value type="choice" value="boolean" > Displaying Links You need to choose a document display that allows you to choose between displaying comments, images or links. It is not possible to combine the display of different document types (for example, to display comments and images). DISPLAY_LINK Boolean The documents are displayed as links in the selected column. All the documents of a cell are shown as links within the relevant cell. Active Example <bi:mod_param_name value="display_link" /> <bi:mod_param_value type="choice" value="boolean" > Column You must specify a column. COLUMN You use this parameter to specify the column with the value that you want to replace with document content. The Set Column Width module describes the possible options for specifying a column as a parameter. More information: Example: Column Width Module [Seite 13] Wert Boolean Active Example for displaying document content in column with index 3 <bi:mod_param_name value="column" /> <bi:mod_param_value type="choice" value="boolean" > <bi:mod_placeholder_list type="orderedlist" > <bi:mod_param_value type="choice" index="1" value="integer" > <bi:integer value="3" /> </bi:mod_placeholder_list> Width It is recommended that you specify a column width because the default column width is usually too narrow for displaying documentation contents. Analysis Web Item: Using Parameter Modification 23

24 WIDTH Integer Width of column in which to display document content. Width in pixels Example for a column width of 200 <bi:mod_param_name value="width" /> <bi:mod_param_value type="choice" index="1" value="integer" > <bi:integer value="200" /> Height (Display of Images Only) To display images, you need to enter the height as the system cannot calculate the size of the images. The height of the row is automatically calculated for displaying comments and links. HEIGHT Integer Height of row in which document content is displayed. Height in pixels Example with Row Height 100 <bi:mod_param_name value="height" /> <bi:mod_param_value type="choice" index="1" value="integer" > <bi:integer value="100" /> Action: Open Document (optional) ACTION_OPEN_ON_CLICK Boolean If a document exists for a cell, a dialog box opens when you click on the cell. This dialog box displays the document and also contains the functionality of the Web Item list of documents. More information: List of Documents [Extern] Active Example for Action Document Open, if document exists <bi:mod_param_name value=" ACTION_OPEN_ON_CLICK " /> <bi:mod_param_value type="choice" value="boolean" > Action: Create Comment (optional) ACTION_NEW_COMMENT_ON_CLICK If no document exists for this cell, you can click on the cell to open a dialog box where you can create a new comment. Analysis Web Item: Using Parameter Modification 24

25 Boolean Active Example for Create Action Comment, if no document exists <bi:mod_param_name value="action_new_comment_on_click" /> <bi:mod_param_value type="choice" value="boolean" > Alignment (Optional) Example for left alignment ALIGNMENT Character string <bi:mod_param_name value="alignment" /> <bi:mod_param_value type="choice" index="1" value="string" > <bi:string value="left" /> Heading (optional) Alignment Possible values are: Left (LEFT) Centered (CENTER) Right (RIGHT) The default value is Centered. You can enter any text for the column heading. It is not possible to use a language-dependent text as a parameter. You can define a language-dependent text for the query in BEx Query Designer. Example for left alignment CAPTION Character string <bi:mod_param_name value="caption" /> <bi:mod_param_value type="choice" index="1" value="string" > <bi:string value="comment" /> Results Row (optional) Column heading Generally it only useful to show documents for characteristic values or data cells. If you also want to display documents in the results rows, you need to activate this parameter. Text RESULT Boolean Example for Create Action Comment, if no document exists <bi:mod_param_name value="result" /> <bi:mod_param_value type="choice" value="boolean" > Display documents in results rows Active Analysis Web Item: Using Parameter Modification 25

26 Maximum Length of Document Content (optional) MAX_CONTENT_LENGTH Integer Maximum length of document content after which any further content is truncated. The fact that content is truncated is indicated by.... Length in characters Example for limit of 1000 characters <bi:mod_param_name value="max_content_length" /> <bi:mod_param_value type="choice" index="1" value="integer" > <bi:integer value="1000" /> Correction for Character Set (optional) FONT_SIZE_OFFSET Integer You use this parameter to influence the calculation of the optimal row height. You only require this parameter if another character set is used in the portal theme. Positive or negative correction to correct the character width. Example for larger character set with correction of 2 <bi:mod_param_name value="font_size_offset" /> <bi:mod_param_value type="choice" index="1" value="integer" > <bi:integer value="2" /> Analysis Web Item: Using Parameter Modification 26

27 Example: Empty Cells as Non Input-Enabled Module Definition Using the Empty Cells as Non Input-Enabled module (com.sap.ip.bi.rig.noninputableemptycells) you can make inputenabled cells non input-enabled. In BI Integrated planning, automatic creation of rows and/or columns can lead to cells being created that are input enabled from a technical point of view, but for process reasons should not be input-enabled in one or more queries. Cells like these are normally locked using data slices, which means though that these combinations are locked against changes (including changes by planning functions) in the entire system. If you only want the lock to apply in one or more queries, you can override the input-enabledness of the cells in the Web Item analysis, using the module. The technical name of this implementation is com.sap.ip.bi.rig.noninputableemptycells. Example Make sure that the module is activated. Otherwise, empty cells will remain input enabled. <bi:analysis_item name="analysis_item_1" designwidth="400" designheight="200" > <bi:data_provider_ref value="dp_1" /> <bi:modification type="choice" value="mod_single_module" > <bi:mod_single_module type="composite" > <bi:active value="x" /> <bi:mod_select type="choice" value="mod_generic_module" > <bi:mod_generic_module type="composite" > <bi:mod_reference value="com.sap.ip.bi.rig.noninputableemptycells" /> </bi:mod_generic_module> </bi:mod_select> </bi:mod_single_module> </bi:modification> </bi:analysis_item> The section below describes the options offered in this module. These options influence how the module functions and are specified as parameters in the parameter list (MOD_PARAMETER_LIST). A parameter is made up of the following elements: 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. COLUMN Using this parameter you can specify the column containing the empty cells that you don t want to set to input-enabled. The Set Column Width module Analysis Web Item: Using Parameter Modification 27

28 Boolean describes the possible options for specifying a column as a parameter. More information: Example: Column Width Module [Seite 13] Active Example with non input-enabled empty cells in column with index 3 <bi:mod_param_name value="column" /> <bi:mod_param_value type="choice" value="boolean" > <bi:mod_placeholder_list type="orderedlist" > <bi:mod_param_value type="choice" index="1" value="integer" > <bi:integer value="3" /> </bi:mod_placeholder_list> Analysis Web Item: Using Parameter Modification 28

29 Definition Example: Own Symbols for Exception Module The Own Symbols for Exception module (com.sap.ip.bi.rig.exceptionimage) enables you to display exceptions with your own symbols or images. You can specify your own symbols in two ways: with three levels using the following parameters ALERT_GOOD, ALERT_CRITICAL ALERT_BAD with nine levels using the parameters ALERT_1 to ALERT_9 If you do not specify a symbol of your own for each alert level, the standard symbol is retained for this alert level. The way the module functions depends on the display type of the exceptions defined using parameter Exception Display (EXCEPTION_RENDERING) in Web Item Analysis. The main difference is the background color. Exception Display with Background Color If this is set to Color, the exception in the cell is displayed as the background color with text as the standard setting. No symbols are displayed with the display type. The modules also has parameter Display Type with Exception Display with Color (EXCEPTION_RENDERING_COLOR). You can use this parameter to select how the background color is combined with an symbol and/or text: Exception Display without Background Color If parameter Exception Display has the value Symbol (SYMBOL), Symbol and Text (SYMBOL_TEXT) or Text and Symbol (TEXT_SYMBOL), the cells are displayed without background color. The module just replaces the standard symbols with your own symbols. The alignment of symbol and text is unaffected. More information: Analysis [Extern] The technical name of the implementation is com.sap.ip.bi.rig.exceptionimage. Example Make sure that the module is activated. Otherwise, the symbols will not be changed. <bi:analysis_item name="analysis_item_1" designwidth="400" designheight="200" > <bi:data_provider_ref value="dp_1" /> <bi:modification type="choice" value="mod_single_module" > <bi:mod_single_module type="composite" > <bi:active value="x" /> <bi:mod_select type="choice" value="mod_generic_module" > <bi:mod_generic_module type="composite" > <bi:mod_reference value="com.sap.ip.bi.rig.exceptionimage" /> <bi:mod_parameter_list type="orderedlist" > <bi:mod_parameter type="composite" index="1" > </bi:mod_parameter>... (add parameter here, see below for details) Analysis Web Item: Using Parameter Modification 29

30 </bi:mod_parameter_list> </bi:mod_generic_module> </bi:mod_select> </bi:mod_single_module> </bi:modification> </bi:analysis_item> The section below describes the options offered in this module. These options influence how the module functions and are specified as parameters in the parameter list (MOD_PARAMETER_LIST). A parameter is made up of the following elements: Placeholder List (MOD_PLACEHOLDER_LIST) If you do not specify the Placeholder List parameter, you can ignore this parameter. Symbols for Three-Level Alert Levels Either the parameters for the three-level alert levels or the nine-level alert levels (see next parameter) need to be specified. ALERT_GOOD, ALERT_CRITICAL, ALERT_BAD Image Example of a symbol from the MIME repository <bi:mod_param_name value="alert_good" /> <bi:mod_param_value type="choice" value="image" > <bi:image value="bwmimerep:///sap/bw/mime/bex/icons/marked_right.gif" /> Symbols for Nine-Level Alert Levels You can use these three parameters to specify the URL or path in the MIME repository (SE80) for your own symbols. You can use these parameters to set symbols for the three alert levels Good, Critical and Bad. URL or path in the MIME Repository: Either the parameters for the three-level alert levels (see previous parameter) or the ninelevel alert levels need to be specified ALERT_1 to ALERT_9 You can use these nine parameters to specify the URL or path in the MIME repository (SE80) for your own symbols. You can use this parameter to set symbols for all nine alert levels. ALERT_1 equates to Good 1 ALERT_2 equates to Good 2 ALERT_3 equates to Good 3 Analysis Web Item: Using Parameter Modification 30

31 ALERT_4 equates to Critical 1 ALERT_5 equates to Critical 2 ALERT_6 equates to Critical 3 ALERT_7 equates to Bad 1 ALERT_8 equates to Bad 2 Image ALERT_9 equates to Bad 3 URL or path in the MIME Repository: Example of a symbol from the MIME repository <bi:mod_param_name value="alert_1" /> <bi:mod_param_value type="choice" value="image" > <bi:image value="bwmimerep:///sap/bw/mime/bex/icons/marked_right.gif" /> Column (optional) If no columns are specified, your own symbols are used for exceptions in all columns. COLUMN Boolean Example for displaying document content in column with index 3 <bi:mod_param_name value="column" /> <bi:mod_param_value type="choice" value="boolean" > <bi:mod_placeholder_list type="orderedlist" > <bi:mod_param_value type="choice" index="1" value="integer" > <bi:integer value="3" /> </bi:mod_placeholder_list> Alignment (Optional) You use this parameter to specify the column whose exceptions you want to replace with your own symbols. The Set Column Width module describes the possible options for specifying a column as a parameter. More information: Example: Column Width Module [Seite 13] Active ALIGNMENT Alignment Character string Possible values are: Analysis Web Item: Using Parameter Modification 31

32 Left (LEFT) Example for left alignment <bi:mod_param_name value="alignment" /> <bi:mod_param_value type="choice" index="1" value="string" > <bi:string value="left" /> Height (Optional) Centered (CENTER) Right (RIGHT) Example with a height of 20 pixels HEIGHT Integer <bi:mod_param_name value="height" /> <bi:mod_param_value type="choice" index="1" value="integer" > <bi:integer value="20" /> The default value is Centered. Height of the row in pixels. It might be necessary to specify the height if the height of one of your own symbols is greater than the standard height of a row. Height in pixels Display Type with Exception Display with Color (Optional) Parameter Display Type with Exception Display with Color is only valid if Web Item Analysis parameter Exception Display (EXCEPTION_RENDERING) has the value Color (COLOR). With all other exception display types, parameter EXCEPTION_RENDERING_COLOR is ignored. EXCEPTION_RENDERING_COLOR Character string Example with the exception displayed as a symbol with background color <bi:mod_param_name value="exception_rendering_color" /> <bi:mod_param_value type="choice" value="string" > <bi:string value="symbol" /> This parameter enables you to decide whether to display just the symbol or the symbol and the text together. You can also define whether the symbol appears to the left of the text or the right. The following display options are available: Symbol and Text (SYMBOL_TEXT) Text and Symbol (TEXT_SYMBOL) Symbol Only (SYMBOL) Analysis Web Item: Using Parameter Modification 32

33 Distance Between Symbol and Content (Optional) Parameter Distance Between Symbol and Content is only valid if Web Item Analysis parameter Exception Display (EXCEPTION_RENDERING) has the value Color (COLOR). With all other exception display types, parameter SEPARATOR is ignored. SEPARATOR Wert Integer Example with a distance of 5 pixels <bi:mod_param_name value="separator" /> <bi:mod_param_value type="choice" index="1" value="integer" > <bi:integer value="5" /> You cam use this parameter to set the distance in pixels between the text and the symbol. (See parameter EXCEPTION_RENDERING_COLOR) Number of pixels Analysis Web Item: Using Parameter Modification 33

34 Definition Example: Format Cells Module The Format Cells module (com.sap.ip.bi.rig.format) enables you to specifically format cells in the Analysis Web Item. The following format functions are supported: Font and background color Bold and italic text Horizontal and vertical alignment As well as the formatting, it is also necessary to specify which cells should be adjusted. Cells can be specified in three ways: Cell type Column Row These three options can be combined, for example to format a particular cell (combination of column and row) or a specific totals row for a characteristic value (combination of cell type Total and Row with Characteristic. 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 iscom.sap.ip.bi.rig.format. More information: Using Modifications [Seite 8] Make sure that the module is activated. Otherwise, the formatting will not be displayed. Example: Format Cells Types Module <bi:analysis_item name="analysis_item_1" designwidth="400" designheight="200" > <bi:data_provider_ref value="dp_1" /> <bi:modification type="choice" value="mod_single_module" > <bi:mod_single_module type="composite" > <bi:active value="x" /> <bi:mod_select type="choice" value="mod_generic_module" > <bi:mod_generic_module type="composite" > <bi:mod_reference value="com.sap.ip.bi.rig.format" /> <bi:mod_parameter_list type="orderedlist" > <bi:mod_parameter type="composite" index="1" >... (add parameter here, see below for details) </bi:mod_parameter> </bi:mod_parameter_list> </bi:mod_generic_module> </bi:mod_select> </bi:mod_single_module> </bi:modification> </bi:analysis_item> Analysis Web Item: Using Parameter Modification 34

35 The section below describes the options offered in this module. These options influence how the module functions and are specified as parameters in the parameter list (MOD_PARAMETER_LIST). A parameter is made up of the following elements: Placeholder List (MOD_PLACEHOLDER_LIST) If you do not specify the Placeholder List parameter, you can ignore this parameter. Cells can be specified in three ways: cell type, column and row. You can combine these three methods. However, at least one of these methods must be used to format cells. Cell type CELL_NONE CELL_STANDARD CELL_DISABLED CELL_READ_ONLY CELL_ALTERNATING CELL_TRANSPARENT CELL_HEADER CELL_TITLE CELL_LEVEL1HEADER CELL_LEVEL2HEADER CELL_LEVEL3HEADER CELL_ALERT_9_BAD_STRONG CELL_ALERT_8_BAD_MEDIUM CELL_ALERT_7_BAD_LIGHTCELL_ALERT_6_CRITICAL_STRONG CELL_ALERT_5_CRITICAL_MEDIUM CELL_ALERT_4_CRITICAL_LIGHT CELL_ALERT_3_GOOD_LIGHT CELL_ALERT_2_GOOD_MEDIUM CELL_ALERT_1_GOOD_STRONG CELL_NEGATIVE CELL_POSITIVE CELL_TOTAL CELL_SUBTOTAL CELL_SUBTOTAL_LIGHT CELL_GROUP_HIGHLIGHTED CELL_GROUP_HIGHLIGHTED_LIGHT CELL_KEY_MEDIUM, CELL_GROUP_LEVEL1 CELL_GROUP_LEVEL2 CELL_GROUP_LEVEL3 CELL_HIERARCHY_LEVEL1 CELL_HIERARCHY_LEVEL2 CELL_HIERARCHY_LEVEL3 CELL_HIERARCHY_LEVEL4 CELL_FILTER CELL_FILTERICON CELL_MARKED CELL_SELECTED1 CELL_SELECTED2 CELL_SELECTED3 CELL_SELECTED4 CELL_SELECTED5 Boolean The cell types here can be selected to format the corresponding cells. Parameter CELL_DEBUG displays the cell type of all cells. Active Example with formatting for cell type CELL_HEADER <bi:mod_param_name value="cell_header" /> <bi:mod_param_value type="choice" value="boolean" > Column COLUMN You can use this parameter to specify the column with the cells to be formatted. The Set Column Width module describes the options for Analysis Web Item: Using Parameter Modification 35