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. At the moment, the system only supports the display of comments (unformatted texts).

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 in Pixels parameter to set the width of the columns with document content.

You must also set the column width for all other columns. You can use the Column Width module to do this.

We recommend that you specify both modules in the module list.

More information:

Example: Column Width Module

Use of Modifications

Make sure that the module is activated. If not, the document content is not 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 possible parameters for displaying document content. If you do not specify the Placeholder List parameter, you can ignore the parameters listed here.

Displaying Comments

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	DISPLAY_TEXT_PLAIN	The selected column displays the content of comments. Comments are unformatted text.
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>

Column

Parameter	Value	Description
Name/Expression (MOD_PARAM_NAME)	COLUMN	You use this parameter to specify the column whose value you want to replace with document content. The Column Width module specifies the possible options for passing a column as a parameter. More information: Example: Column Width Module
Value (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

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 with 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>

Alignment

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>

Maximum length of document content

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

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>