Example: Column Width Module
Definition
The Column Width module (com.sap.ip.bi.rig.ColumnWidth) enables the definition of the column width in the Analysis Web item. There are several possibilities for specifying the columns:
● Default width
● Default width for fixed columns
● Default width for specific index
● Default width for specific characteristic
● Default width for specific characteristic value
● Default width for specific attribute
● Default width for specific structure member (key figure or characteristic value)
The technical name of the implementation is com.sap.ip.bi.rig.ColumnWidth.
● Other modules (e.g. documentation contents) can also have the parameter Column (COLUMN) or Row (ROW). The possibilities available here for entering a column are the same as for the module Set Column Width. Note that the value might be Boolean rather than an integer.
● All columns that are not explicitly specified have the default width. If you do not specify a default width, all columns that are not explicitly specified have the width 0. This means that they are not visible.
The column widths for a specific characteristic, attribute, or structure value overwrite the width for a specific index and the default widths. An index width overwrites the default widths.
If you specify multiple columns, you have to change the names of the parameters. The COLUMN parameter name must be different for each column. You must therefore add a number to the names. There are the following supported ways of doing this:
● COLUMN[<number>]
● COLUMN_<number>
Make sure that the module is activated. If not, the column widths do not change.
Example
<bi:ANALYSIS_ITEM name="ANALYSIS_ITEM_1" designwidth="400" designheight="200" >
<bi:DATA_PROVIDER_REF value="DP_1" />
<bi:MODIFICATION type="CHOICE" value="MOD_SINGLE_MODULE" >
<bi:MOD_SINGLE_MODULE type="COMPOSITE" >
<bi:ACTIVE value="X" />
<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >
<bi:MOD_GENERIC_MODULE type="COMPOSITE" >
<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.ColumnWidth" />
<bi:MOD_PARAMETER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAMETER type="COMPOSITE" index="1" >
... (add parameter here, see below for details)
</bi:MOD_PARAMETER>
</bi:MOD_PARAMETER_LIST>
</bi:MOD_GENERIC_MODULE>
</bi:MOD_SELECT>
</bi:MOD_SINGLE_MODULE>
</bi:MODIFICATION>
</bi:ANALYSIS_ITEM>
The following section describes the various options offered in this module. The options are specified as parameters in the parameter list (MOD_PARAMETER_LIST). A parameter is made up of the following elements:
●
Name/Expression
(MOD_PARAM_NAME)
● Value (MOD_PARAM_VALUE)
● Placeholder List (MOD_PLACEHOLDER_LIST)
If the Placeholder List parameter is not specified, you can ignore this parameter.
Default width
The default width is important because it is used for all non-specified columns. If you do not specify a default width, all non-specified columns are set to 0, which means that they are not visible.
Default width
Parameter |
Value |
Description |
Name/Expression (MOD_PARAM_NAME) |
COLUMN[*] COLUMN_DEFAULT |
Default column |
Value (MOD_PARAM_VALUE) |
Integer |
Width in pixels |
Example for default width of 50
<bi:MOD_PARAM_NAME value="COLUMN_DEFAULT" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="50" />
</bi:MOD_PARAM_VALUE>
Default width for fixed columns
The default width for fixed columns is used for characteristic and key figure columns in the drilldown.
Default width for fixed columns
Parameter |
Value |
Description |
Name/Expression (MOD_PARAM_NAME) |
COLUMN_FIX COLUMN_FIX[*] COLUMN_FIX_DEFAULT |
Default column |
Value (MOD_PARAM_VALUE) |
Integer |
Width in pixels |
Default width for specific index
The column is identified by the specified index. The width of the specified column is 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
Parameter |
Value |
Description |
Name/Expression (MOD_PARAM_NAME) |
COLUMN[<index>] COLUMN_<index> |
<Index> is the column. The first column has index 1. |
Value (MOD_PARAM_VALUE) |
Integer |
Width in pixels |
Placeholder List (MOD_PLACEHOLDER_LIST) |
Blank |
Leave Placeholder List blank. |
Example for column width of 100 for column with index 5 and index 6
<<bi:MOD_PARAM_NAME value="COLUMN[5]" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PARAM_NAME value="COLUMN[6]" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
Example with a different syntax
<bi:MOD_PARAM_NAME value="COLUMN_5" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PARAM_NAME value="COLUMN_6" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
Alternative specification of index using placeholder list
Parameter |
Value |
Description |
Name/Expression (MOD_PARAM_NAME) |
COLUMN[<number>] COLUMN_< number > |
<number> is the sequential number. |
Value (MOD_PARAM_VALUE) |
Integer |
Width in pixels |
Placeholder List (MOD_PLACEHOLDER_LIST) |
Type = integer, value = <index> |
<Index> is the column. The first column has index 1. |
Example for column width of 100 for column with index 5 and index 6
Note the parameter COLUMN_... in place of the index is a continuous number.
<bi:MOD_PARAM_NAME value="COLUMN_1" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="5" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
<bi:MOD_PARAM_NAME value="COLUMN_2" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="100" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >
<bi:INTEGER value="6" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Default width for specific characteristic
The column is determined by the specification of a characteristic. The column with the specified characteristic is always modified in line with the specified width. This is independent of the navigational state.
Default width for specific characteristic
Parameter |
Value |
Description |
Name/Expression (MOD_PARAM_NAME) |
COLUMN[<number>] COLUMN_< number > |
<number> is the sequential number. |
Value (MOD_PARAM_VALUE) |
Integer |
Width in pixels |
Placeholder List (MOD_PLACEHOLDER_LIST) |
Type = characteristic, value = <characteristic> |
<characteristic> is the technical name of the characteristic. |
Example for column width of 200 for product characteristic (0D_PH2)
<bi:MOD_PARAM_NAME value="COLUMN_1" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="200" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="CHARACTERISTIC" >
<bi:CHARACTERISTIC value="0D_PH2" text="0D_PH2" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Default width for specific characteristic value
The column is determined by the specification of a characteristic with a characteristic value. The column with the specified characteristic value is always modified in line with the specified width. This is independent of the navigational state.
Default width for specific characteristic value
Parameter |
Value |
Description |
Name/Expression (MOD_PARAM_NAME) |
COLUMN[<number>] COLUMN_< number > |
<number> is the sequential number. |
Value (MOD_PARAM_VALUE) |
Integer |
Width in pixels |
Placeholder List (MOD_PLACEHOLDER_LIST) |
Types Characteristic Value and Value consisting of <characteristic> and <value> |
<characteristic> is the technical name of the characteristic and <value> is the technical characteristic value |
Example for column width of 200 for characteristic value PDS12 of the characteristic product (0D_PH2)
<bi:MOD_PARAM_NAME value="COLUMN_1" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="200" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="CHARACTERISTIC_MEMBER" >
<bi:CHARACTERISTIC_MEMBER type="COMPOSITE" >
<bi:CHARACTERISTIC value="0D_PH2" text="0D_PH2" />
<bi:MEMBER_NAME value="PDS12" text="PDS12" />
</bi:CHARACTERISTIC_MEMBER>
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Default width for specific attribute
The column is determined by the specification of an attribute. The column with the specified attribute is always modified in line with the specified width. This is independent of the navigational state.
Default width for specific attribute
Parameter |
Value |
Description |
Name/Expression (MOD_PARAM_NAME) |
COLUMN[<number>] COLUMN_< number > |
<number> is the sequential number. |
Value (MOD_PARAM_VALUE) |
Integer |
Width in pixels |
Placeholder List (MOD_PLACEHOLDER_LIST) |
Type = attribute, value = <attribute> |
<attribute> is the technical name of the attribute. |
Example for column width of 200 for price attribute (0D_PREIS)
<bi:MOD_PARAM_NAME value="COLUMN_1" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="200" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INFO_OBJECT_ATTRIBUTE" >
<bi:INFO_OBJECT_ATTRIBUTE value="0D_PREIS" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Default width for specific member
The column is determined by the specification of a structure member (key figure). The column with the specified structure member (key figure) is always modified in line with the specified width. This is independent of the navigational state.
A structure value is generally a key figure. However, it can also be a selection or a formula. You must specify the structure value as a UID. You can find this UID in the BEx Query Designer, in the properties of structure component on the Enhanced tab page.
If you assign a technical name in the properties of the BEx Query Designer, you can specify a technical name.
Structure value is actually a dropdown box. Press F11 to make the field input-ready. You can then insert the technical name of the key figure from the query definition.
Default width for specific member
Parameter |
Value |
Description |
Name/Expression (MOD_PARAM_NAME) |
COLUMN[<number>] COLUMN_< number > |
<number> is the sequential number. |
Value (MOD_PARAM_VALUE) |
Integer |
Width in pixels |
Placeholder List (MOD_PLACEHOLDER_LIST) |
Type = structure member, value = <structure member> |
<structure member> is the technical name of the structure member (key figure). |
Example for column width of 150 for key figure
<bi:MOD_PARAM_NAME value="column_3" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="INTEGER" >
<bi:INTEGER value="150" />
</bi:MOD_PARAM_VALUE>
<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >
<bi:MOD_PARAM_VALUE type="CHOICE" index="2" value="STRUCTURE_MEMBER" >
<bi:STRUCTURE_MEMBER value="45240PLO41Z7TROE321MNA46C" text="45240PLO41Z7TROE321MNA46C" />
</bi:MOD_PARAM_VALUE>
</bi:MOD_PLACEHOLDER_LIST>
Continuous text with automatic line breaks (optional)
Parameter |
Value |
Description |
Name/Expression |
WRAPPING |
Using this parameter, you can specify whether the headers are displayed as continuous text. Line breaks are automatically added to the continuous text. |
Value (MOD_PARAM_VALUE) |
Boolean |
Active |
Example: automatic line breaks in headers
<bi:MOD_PARAM_NAME value="WRAPPING" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>
Continuous text for all lines (optional)
Parameter |
Value |
Description |
Name/Expression |
ALL_ROWS_WRAPPING |
Using this parameter, you can specify whether all lines are displayed as continuous text. Line breaks are automatically added to the continuous text. |
Value (MOD_PARAM_VALUE) |
Boolean |
Active |
Note that preparing the continuous text is very time-consuming. Only use this parameter if you really need continuous text.
Example: automatic line breaks in all lines
<bi:MOD_PARAM_NAME value="ALL_ROWS_WRAPPING" />
<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >
<bi:BOOLEAN value="X" />
</bi:MOD_PARAM_VALUE>