Example: Document Content Module

Definition

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

The technical name of the implementation is com.sap.ip.bi.rig.DocumentContent.

Note

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

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

Using Modifications

Note

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

Example for Column Width and Document Content modules

<bi:ANALYSIS_ITEM name="ANALYSIS_ITEM_1" designwidth="400" designheight="200" >

<bi:DATA_PROVIDER_REF value="DP_1" />

<bi:MODIFICATION type="CHOICE" value="MOD_SINGLE_MODULE" >

<bi:MOD_MODULE_LIST type="ORDEREDLIST" >

<bi:MOD_SINGLE_MODULE type="COMPOSITE" index="1" >

<bi:ACTIVE value="X" />

<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >

<bi:MOD_GENERIC_MODULE type="COMPOSITE" >

<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.ColumnWidth" />

<bi:MOD_PARAMETER_LIST type="ORDEREDLIST" >

<bi:MOD_PARAMETER type="COMPOSITE" index="1" >

... (add parameter here, see below for details)

</bi:MOD_PARAMETER>

</bi:MOD_PARAMETER_LIST>

</bi:MOD_GENERIC_MODULE>

</bi:MOD_SELECT>

</bi:MOD_SINGLE_MODULE>

<bi:MOD_SINGLE_MODULE type="COMPOSITE" index="2" >

<bi:ACTIVE value="X" />

<bi:MOD_SELECT type="CHOICE" value="MOD_GENERIC_MODULE" >

<bi:MOD_GENERIC_MODULE type="COMPOSITE" >

<bi:MOD_REFERENCE value="com.sap.ip.bi.rig.DocumentContent" />

<bi:MOD_PARAMETER_LIST type="ORDEREDLIST" >

<bi:MOD_PARAMETER type="COMPOSITE" index="1" >

... (add parameter here, see below for details)

</bi:MOD_PARAMETER>

</bi:MOD_PARAMETER_LIST>

</bi:MOD_GENERIC_MODULE>

</bi:MOD_SELECT>

</bi:MOD_SINGLE_MODULE>

</bi:MOD_MODULE_LIST>

</bi:MODIFICATION>

</bi:ANALYSIS_ITEM>

The section below describes the options offered in this module. These options influence how the module functions and are specified as parameters in the parameter list (MOD_PARAMETER_LIST). A parameter is made up of the following elements:

Name/Expression(MOD_PARAM_NAME)
Value (MOD_PARAM_VALUE)
Placeholder List(MOD_PLACEHOLDER_LIST)

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

Displaying Comments

You need to choose a document display that allows you to choose between displaying comments, images or links. It is not possible to combine the display of different document types (for example, to display comments and images).

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	DISPLAY_TEXT_PLAIN	The selected column displays the content of comments. Comments are unformatted text. Only the first comment in a cell is shown.
Value (MOD_PARAM_VALUE)	Boolean	Active

Example

<bi:MOD_PARAM_NAME value="DISPLAY_TEXT_PLAIN" />

<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >

<bi:BOOLEAN value="X" />

</bi:MOD_PARAM_VALUE>

Displaying Images

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	DISPLAY_IMAGE	Any documents that are images are displayed in the selected column. Only the first image in a cell is shown.
Value (MOD_PARAM_VALUE)	Boolean	Active

Example

<bi:MOD_PARAM_NAME value="DISPLAY_IMAGE" />

<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >

<bi:BOOLEAN value="X" />

</bi:MOD_PARAM_VALUE>

Displaying Links

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	DISPLAY_LINK	The documents are displayed as links in the selected column. All the documents of a cell are shown as links within the relevant cell.
Value (MOD_PARAM_VALUE)	Boolean	Active

Example

<bi:MOD_PARAM_NAME value="DISPLAY_LINK" />

<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >

<bi:BOOLEAN value="X" />

</bi:MOD_PARAM_VALUE>

Column

You must specify a column.

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	COLUMN	You use this parameter to specify the column with the value that you want to replace with document content. The Set ColumnWidth module describes the possible options for specifying a column as a parameter. More information: Example: Column Width Module
Wert(MOD_PARAM_VALUE)	Boolean	Active

Parameter

Value

Description

Name/Expression (MOD_PARAM_NAME)

COLUMN

You use this parameter to specify the column with the value that you want to replace with document content.

The Set ColumnWidth module describes the possible options for specifying a column as a parameter.

More information: Example: Column Width Module

Wert(MOD_PARAM_VALUE)

Boolean

Active

Example for displaying document content in column with index 3

<bi:MOD_PARAM_NAME value="COLUMN" />

<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >

<bi:BOOLEAN value="X" />

</bi:MOD_PARAM_VALUE>

<bi:MOD_PLACEHOLDER_LIST type="ORDEREDLIST" >

<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >

<bi:INTEGER value="3" />

</bi:MOD_PARAM_VALUE>

</bi:MOD_PLACEHOLDER_LIST>

Width

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

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	WIDTH	Width of column in which to display document content.
Value (MOD_PARAM_VALUE)	Integer	Width in pixels

Example for a column width of 200

<bi:MOD_PARAM_NAME value="WIDTH" />

<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >

<bi:INTEGER value="200" />

</bi:MOD_PARAM_VALUE>

Height (Display of Images Only)

To display images, you need to enter the height as the system cannot calculate the size of the images. The height of the row is automatically calculated for displaying comments and links.

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	HEIGHT	Height of row in which document content is displayed.
Value (MOD_PARAM_VALUE)	Integer	Height in pixels

Example with Row Height 100

<bi:MOD_PARAM_NAME value="HEIGHT" />

<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >

<bi:INTEGER value="100" />

</bi:MOD_PARAM_VALUE>

Action: Open Document (optional)

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	ACTION_OPEN_ON_CLICK	If a document exists for a cell, a dialog box opens when you click on the cell. This dialog box displays the document and also contains the functionality of the Web Item list of documents. More information: List of Documents
Value (MOD_PARAM_VALUE)	Boolean	Active

Example for Action Document Open, if document exists

<bi:MOD_PARAM_NAME value="ACTION_OPEN_ON_CLICK " />

<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >

<bi:BOOLEAN value="X" />

</bi:MOD_PARAM_VALUE>

Action: Create Comment (optional)

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	ACTION_NEW_COMMENT_ON_CLICK	If no document exists for this cell, you can click on the cell to open a dialog box where you can create a new comment.
Value (MOD_PARAM_VALUE)	Boolean	Active

Example for Create Action Comment, if no document exists

<bi:MOD_PARAM_NAME value="ACTION_NEW_COMMENT_ON_CLICK" />

<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >

<bi:BOOLEAN value="X" />

</bi:MOD_PARAM_VALUE>

Alignment (Optional)

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	ALIGNMENT	Alignment
Value (MOD_PARAM_VALUE)	Character string	Possible values are: Left (LEFT) Centered (CENTER) Right (RIGHT) The default value is Centered.

Parameter

Value

Description

Name/Expression (MOD_PARAM_NAME)

ALIGNMENT

Alignment

Value (MOD_PARAM_VALUE)

Character string

Possible values are:

Left (LEFT)
Centered (CENTER)
Right (RIGHT)

The default value is Centered.

Example for left alignment

<bi:MOD_PARAM_NAME value="ALIGNMENT" />

<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="STRING" >

<bi:STRING value="LEFT" />

</bi:MOD_PARAM_VALUE>

Heading (optional)

You can enter any text for the column heading. It is not possible to use a language-dependent text as a parameter. You can define a language-dependent text for the query in BEx Query Designer.

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	CAPTION	Column heading
Value (MOD_PARAM_VALUE)	Character string	Text

Example for left alignment

<bi:MOD_PARAM_NAME value="CAPTION" />

<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="STRING" >

<bi:STRING value="Comment" />

</bi:MOD_PARAM_VALUE>

Results Row (optional)

Generally it only useful to show documents for characteristic values or data cells. If you also want to display documents in the results rows, you need to activate this parameter.

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	RESULT	Display documents in results rows
Value (MOD_PARAM_VALUE)	Boolean	Active

Example for Create Action Comment, if no document exists

<bi:MOD_PARAM_NAME value="RESULT" />

<bi:MOD_PARAM_VALUE type="CHOICE" value="BOOLEAN" >

<bi:BOOLEAN value="X" />

</bi:MOD_PARAM_VALUE>

Maximum Length of Document Content (optional)

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	MAX_CONTENT_LENGTH	Maximum length of document content after which any further content is truncated. The fact that content is truncated is indicated by "...".
Value (MOD_PARAM_VALUE)	Integer	Length in characters

Example for limit of 1000 characters

<bi:MOD_PARAM_NAME value="MAX_CONTENT_LENGTH" />

<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >

<bi:INTEGER value="1000" />

</bi:MOD_PARAM_VALUE>

Correction for Character Set (optional)

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	FONT_SIZE_OFFSET	You use this parameter to influence the calculation of the optimal row height. You only require this parameter if another character set is used in the portal theme.
Value (MOD_PARAM_VALUE)	Integer	Positive or negative correction to correct the character width.

Parameter

Value

Description

Name/Expression (MOD_PARAM_NAME)

FONT_SIZE_OFFSET

You use this parameter to influence the calculation of the optimal row height.

You only require this parameter if another character set is used in the portal theme.

Value (MOD_PARAM_VALUE)

Integer

Positive or negative correction to correct the character width.

Example for larger character set with correction of 2

<bi:MOD_PARAM_NAME value="FONT_SIZE_OFFSET" />

<bi:MOD_PARAM_VALUE type="CHOICE" index="1" value="INTEGER" >

<bi:INTEGER value="2" />

</bi:MOD_PARAM_VALUE>