WAD Enhancements using Analysis Web Item Modules
1. Introduction
This document brings in to light few enhancements basics which can be applied in an Analysis Web item to beautify the current functionality of the Web template solution as per the client’s charms. This can be achieved through the options available for the modification in the properties of the Analysis Web Item and by using the standard SAP provided modules and leveraging the available modules to enhance the Web Template in the desired ways.
These modifications make use of modules which contains parameters that can be controlled by the user and enhance WAD functionality without much effort.
2. Objective
This document provides the “How To” approach to make use of the Analysis web Item module implementation in general for WAD enhancement.
For this purpose two important modules as below are covered which can be used to enhance the frontend display of the Web Templates.
- com.sap.ip.bi.rig.format : Formatting Module
- com.sap.ip.bi.rig.scrolling : Scrolling Module
3. Analysis Web Item Modules
3.1 Formatting Module
The module [com.sap.ip.bi.rig.Format] allows formatting the cells in the Analysis Web Item.
Mentioned below is the step by step approach to enhance the functionality of the Analysis Web Item by the use of formatting module [com.sap.ip.bi.rig.Format].
3.1.1 Steps to use formatting module
3.1.1.1 Specify the module in the Analysis Web item
None : This specifies you are not using any modification module, by default none is set.
Single Module : This is selected when you need to implement one specific Module for formatting.
Module List : This is used when you need more than one module, this options describes a list of Modules as the name itself suggests.
3.1.1.2 Determine the parameters for the selected module to be used
Alias Name : Give any alias name which is according to your wish.
Active : Set Active as ‘ON’ if you want to activate the Module. By default it is set to OFF.
Press on the box button on the extreme right of the Generic Module Row (marked as red in the screenshot) and enter the name of the Implementation to be used and the parameters to be assigned.
3.1.1.3 Choosing the Parameter and associated Components
The Parameters generally defines the functionality which you want to enhance using the module. A module has various parameters which can be used to enhance the functionally. For example below parameters of the Formatting module [com.sap.ip.bi.rig.Format] are considered.
- Column
- Row
- Text Color
- Background Color
- Bold Text
- Italic Text
- Horizontal Alignment
- Vertical Alignment
When you choose a parameter, few other options also need to be filled for the respective parameter which is described in the steps as below.
3.1.2 Additional Components of the Parameters
Each Module has its own specific set of Additional Components which needs to be enhanced in the Analysis Web item. Some of the important Additional Components for the Formatting Module are as provided.
3.1.3 Achieve Formatting changes
In the below sections few formatting requirements are considered and also the ways to achieve the same through the Module parameters
3.1.3.1 Changing the Text Color
If user wants to select the first Row and set its Text Color to Red using the formatting module [com.sap.ip.bi.rig.Format] then the steps as below to be followed
- Set the Parameter as Row
- Set the Value as Boolean
- In Placeholder select the Row for which the text color to be changed.
- Set the Parameter as Color
- Set the Value as String
- String as the name of the color (RED in this example)
- In Placeholder select the Row which you want.
Desired Output
3.1.3.2 Changing the Background Color
If user wants to select the first Row and set its background Color to Red using the formatting module [com.sap.ip.bi.rig.Format] then the steps as below to be
followed
- Set the Parameter as Row
- Set the Value as Boolean
- In Placeholder select the Row which you want.
- Set the Parameter as Background_Color
- Set the Value as String
- String as the name of the color (RED in this example)
Desired Output
3.1.3.3 Making a Text Bold and Italic
- Set the Parameter as Row
- Set the Value as Boolean
- In Placeholder select the Row which you want. Here the user wants to make the Row 1 and Row 5 as Bold and Italic
- Set the Parameter as Bold
- Set the Value as Boolean
- Set the Parameter as Bold
- Set the Value as Boolean
Desired Output
3.2 Scrolling Module
The module [com.sap.ip.bi.rig.scrolling] allows fixing the rows/columns in Analysis Web Item.
Mentioned below is the step by step approach to enhance the functionality of the Analysis Web Item by the use of scrolling module [com.sap.ip.bi.rig.scrolling].
3.2.1 Steps to use formatting module
3.2.1.1 Specify the module in the Analysis Web item
None : This specifies you are not using any modification module, by default none is set.
Single Module : This is selected when you need to implement one specific Module for formatting.
Module List :This is used when you need more than one module, this options describes a list of Modules as the name itself suggests.
3.2.1.2 Determine the parameters for the selected module to be used
Alias Name : Give any alias name which is according to your wish.
Active : Set Active as ‘ON’ if you want to activate the Module. By default it is set to OFF.
Press on the box button on the extreme right of the Generic Module Row (marked as red in the screenshot) and enter the name of the Implementation to be used and the parameters to be assigned.
3.2.1.3 Choosing the Parameter and associated Components
Below parameters of the scrolling module [com.sap.ip.bi.rig.scrolling] are considered.
- Column
- Row
3.2.2 Additional Components of the Parameters
Each Module has its own specific set of Additional Components which needs to be enhanced in the Analysis Web item. Some of the important Additional Components for the scrolling module are as provided.
3.2.3 Achieve Scrolling changes
In the below sections the scrolling requirements are considered and also the ways to achieve the same through the Module parameters.
3.2.3.1 Freezing the rows/columns
If user wants to freeze the rows/columns using the scrolling module [com.sap.ip.bi.rig.scrolling] then the steps as below to be followed.
- Set the Parameter as Row /Column
- Set the Value as Boolean
- In Placeholder select the Row/Column which you want to freeze.
- Set the Parameter as Column
- Set the Value as Boolean
- In Placeholder select the number of columns you want to freeze. In this example will freeze the 1st column only. However this number can be put to the
desired value depending on the requirement.
Desired Output
As clear in the screenshot below a scroll bar can be seen which will enable the scrolling and also freeze the 1st column while moving downwards. In this way scrolling can be enabled in the Web item Analysis in WAD Templates.
4. Appendix
Some Other Important Modification Modules are
- com.sap.ip.bi.rig.ColumnWidth
- com.sap.ip.bi.rig.DocumentContent
- com.sap.ip.bi.rig.NegativeNumber
- com.sap.ip.bi.rig.NonInputableEmptyCells
- com.sap.ip.bi.rig.ExceptionImage
- com.sap.ip.bi.rig.CopyPaste
- com.sap.ip.bi.rig.Planning
Nice description. Original sap help is too short!
thanks, very good article. is there any other way to enhance by abap the WAD? for example to call a BSP application from a Web template?
Sorry for the late response . Well i have heard about standard Class which can be called via WAD if that is what you were looking for . Haven't really been too much into BSP's so cant comment on that .
If you need more info on using ABAP in WAD do let me know !
Dear Pranav,
actually i want from my WAd application to call another application. I don't want to use a fixed url, but i want every rime to call dynamically this url, let's say by reading a SAP table , for example table url_prefix.
Thanks, Its really very well explain.
Just a small change for Scrolling Module -COLUMN parameter.
We have to specify Value as "Integer" not string, else it will not work.
Thanks for the fix ! 🙂
thx for this step by step guide
I added a freeze pane to my IP web template with com.sap.ip.bi.rig.Scrolling and this looks good but now the ability to select a row has stopped even though this is still set to [SINGLE]
have you seen this problem before? are the two incompatible?
I haven't come across any such issue in the past . I could use both the functionalities without issue maybe it is a small setting which is causing the issue .
I will try to check and maybe try to replicate the scenario and let you know incase i succeed .
Hi Ian
3 years down the road. Did you by any chance solve the issue with select row
Hi Bo
In a sense since the client is no longer an SAP customer so problem solved 🙂
But now being serious, sadly I did not get a resolution to this issue at the time and the client lived without frozen panes.
Ian
Hello,
two comments. I'm using WAD with BI AddOn 7.X based on GUI 7.4 on a BW 7.5 system.
Thanks to Pranav Kandpal for this tutorial, it helped me a lot!