11/18/2016

AnalysisBExWebApplicationDesignerSAPLibrary

TheBestRunBusinessesRunSAP

TechnologyPlatform

SAPNetWeaver

7.3

Analysis
Definition
AWebitemthatallowsyoutodisplaydatainatablewithanalyticalfunctions.

Use
TheAnalysisWebitemdisplaysthevaluesofadataproviderasatableintheWebapplication.Thelist
geometriesthatareusedintheBExAnalyzerarealsosupportedhere.Characteristicsandstructurescanbe
displayedinbothrowsandcolumns.

Structure
ThefollowinginformationliststheparametersfortheAnalysisWebitem,arrangedaccordingtothevarious
parametergroupings.
Display
Parameter

Description

WidthinPixels(WIDTH)

YouusethisparametertospecifythewidthoftheWeb
item.

FullWidth(FULL_WIDTH)

Youusethisparametertospecifythatthevalueinthe
WidthinPixels(WIDTH)parameteristobeignoredand
thatthewidthistobesetto100%instead.Thefullwidth
dependsonthewidthoftheenvironmentinwhichthe
Webitemisembedded(forexample,thewidthofatab
pageonaportalpageorinaniView).

HeightinPixels(HEIGHT)

YouusethisparametertospecifytheheightoftheWeb
item.

FullHeight(FULL_HEIGHT)

Youusethisparametertospecifythatthevalueinthe
HeightinPixels(HEIGHT)parameteristobeignoredand
thattheheightistobesetto100%instead.Thefullheight
dependsontheheightoftheenvironmentinwhichthe
Webitemisembedded(forexample,theheightofatab
pageonaportalpageoriView).

http://help.sap.com/SAPhelp_nw73/helpdata/en/76/489d39d342de00e10000000a11402f/content.htm

1/9

11/18/2016

AnalysisBExWebApplicationDesignerSAPLibrary

Parameter

Description

Visibility(VISIBILITY)

YouusethisparametertospecifywhethertheWebitem
shouldbevisibleintheWebapplication.

WithTray(WITH_TRAY)

YouusethisparametertospecifywhethertheAnalysis
WebitemistohaveaniconthatallowstheWebitemtobe
expandedandcollapsed.Formoreinformationaboutthis
parameter,seeParameterTray.

InternalDisplay
Parameter

Description

DisplayMode
(ANALYSIS_ITEM_MODE)

Youusethisparametertospecifyinwhichmodethe
AnalysisWebitemistobedisplayed:Thefollowing
optionsareavailable:
Automatic(AIM_AUTOMATIC)
Thesystemautomaticallyselectsthemostsuitable
modefortheAnalysisWebitem.
StandardAnalysisGrid(AIM_STANDARD_GRID)
ThedefaultdisplayisusedtodisplaytheAnalysis
Webitem.
PlainHTML(AIM_PLAIN_HTML)
TheAnalysisWebitemisdisplayedasplainHTML.
Thismodeisparticularlyusefulfordisplayinglarge
amountsofdataquicklyorforaccessingdatausing
JavaScript.Forexample,youcanhidetheAnalysis
Webiteminanapplicationandaccessthedataby
usingJavaScript.
NotethattheplainHTMLdisplayisnomorethana
puredisplayfunctionfordisplayingthedata.All
dataisdisplayedwithoutformatting(suchascolors
oricons)inatableononepage,pagingsettings
arenotapplied,andanyinteractionwiththedata
(suchasdraganddrop,orsorting)isnotsupported.

Modification
(MODIFICATION)

Thisparameterprovidesagenericinterfaceforchanging
theanalysisWebitem.Thisenablesyoutousesimilar
optionstothoseavailableinearlierreleaseswiththeWeb
DesignAPIforTables.
Moreinformation:WebItemAnalysis:Parameter
Modification.

AlternateTableRowStyles(ALTERNATE_STYLES)

Youusethisparametertospecifywhetherthestylesfor
theoddandeventablerowsaretoalternateandbe
displayedinastripedlist.
Totalscellsarenotincludedinthisdisplay.

DisplayRepeated
Texts(REPEATED_TEXTS_DISPLAYED)

Youusethisparametertospecifywhetherrepeatedtexts
orkeysaretobedisplayedmorethenonceorwhetherthe
repetitionsaretobesuppressedandthecellsmerged.

http://help.sap.com/SAPhelp_nw73/helpdata/en/76/489d39d342de00e10000000a11402f/content.htm

2/9

11/18/2016

AnalysisBExWebApplicationDesignerSAPLibrary

Parameter

Description

DisplayScalingFactors(SCALING_FACTORS_VISIBLE)

Youusethisparametertospecifywhetherthescaling
factorsaretobedisplayed,ifsupported.

RowHeaderVisible(ROW_HEADER_VISIBLE)

Youusethisparametertospecifywhethertherowheader
areaistobedisplayed.Therowheaderareadisplaysthe
labelstotheleftofthedata.

ColumnHeaderVisible(COLUMN_HEADER_VISIBLE)

Youusethisparametertospecifywhetherthecolumn
headerareaistobedisplayed.Thecolumnheaders
displaythelabelsabovethedata.

DataCellsVisible(DATA_CELLS_VISIBLE)

Youusethisparametertospecifywhetherthedatacells
aretobedisplayed.

NumberofNewLines(NEW_LINES_COUNT)

Youusethisparametertoinsertanyrequirednumberof
emptyrowsintothetable.Thedefaultsettingforthis
parameteris0.

Note
Dependingonthequerysettings,thisparameteris
usedtoinsertcolumnsinsteadofrows.
PositionofNewLines(NEW_LINES_POSITION)

Youusethisparametertospecifythepositionatwhichthe
additionalemptyrowsaretobeinserted.Youcanselect
from:
Top
Bottom

Note
IftheNumberofNewLinesparameter
(NEW_LINES_COUNT)insertscolumnsinstead
ofrowsasaresultoftheexistingquerysettings,
LeftandRightarethevaluestoselectfrom
insteadoftheabovevalues.
DataColumnFrom(DATA_COLUMN_FROM)

Youusethisparametertospecifythedatacolumnfrom
whichthedataistobedisplayed.Thedefaultsettingfor
thisparameteris1.
Thesettingforthisparameterisseparatetothesettingfor
theDataColumnTo(DATA_COLUMN_TO)parameter.

DataColumnTo(DATA_COLUMN_TO)

Youusethisparametertospecifythedatacolumnupto
whichthedataistobedisplayed.
Thedefaultsettingforthisparameteris0.Ifthevalueis0,
thesystemtriestodisplayallcolumns.Iftherearetoo
many,ascrollingareaisinserted.
Ifthevalueisnot0,dataisdisplayeduptothespecified
columnonly.Noscrollingareaisprovided.
Thesettingforthisparameterisindependentofthesetting
fortheDataColumnFrom(DATA_COLUMN_FROM)
parameter.

http://help.sap.com/SAPhelp_nw73/helpdata/en/76/489d39d342de00e10000000a11402f/content.htm

3/9

11/18/2016

AnalysisBExWebApplicationDesignerSAPLibrary

Parameter

Description

DataRowFrom(DATA_ROW_FROM)

Youusethisparametertospecifythedatarowfromwhich
thedataistobedisplayed.Thedefaultsettingforthis
parameteris1.

DataRowTo(DATA_ROW_TO)

Youusethisparametertospecifythedatarowuptowhich
thedataistobedisplayed.
Thedefaultsettingforthisparameteris0.Ifthevalueis0,
thesystemtriestodisplayallrows.Iftherearetoomany,a
scrollingareaisinserted.
Ifthevalueisnot0,dataisdisplayeduptothespecified
rowonly.Noscrollingareaisprovided.

Behavior
Parameter

Description

AllowNavigation(INTERACTION_ALLOWED)

Youusethisparametertospecifywhethernavigationand
otherinteractionsshouldbepossibleintheWeb
application.

OnlyHierarchy
Navigation(ONLY_HIERARCHY_NAVIGATION)

Youusethisparametertospecifywhetherthecontext
menuistobehiddenandwhetherexpandandcollapse
optionsonlyaretobeprovidedforthelist.

http://help.sap.com/SAPhelp_nw73/helpdata/en/76/489d39d342de00e10000000a11402f/content.htm

4/9

11/18/2016

AnalysisBExWebApplicationDesignerSAPLibrary

Parameter

Description

RowSelection(SELECT_ROWS)

Youusethisparametertospecifywhetherandhowmany
rowstheusercanselectatruntime.Youcanalsousethis
rowselectionincommandssothatacommandcanalso
beexecutedwhenrowsareselectedatruntime.
Youcanchoosefromthefollowingoptions:
None(NONE)(defaultvalue)
Rowscannotbeselectedatruntime.
Single(SINGLE)
Userscanselectonerowatruntime.
SinglewithCommands
(SINGLE_WITH_COMMAND)
Userscanselectonerowatruntime.Whenarowis
selected,anactivationordeactivationactionis
executedwithacorrespondingcommand.
Youcanchoosefromthefollowingparameters:
ActivationAction(ACTIVATION_ACTION)
DeactivationAction
(DEACTIVATION_ACTION)
Usingthecommandwizard,youcanchoosea
commandthatistobeexecutedwhentheselected
rowisactivatedordeactivated.Formore
information,seeCommands.
Multiple(MULTIPLE)
Atruntime,userscanselectmultiplerows.
Forexample,youcanassociatetherowselectionwiththe
SetFilterValuesUsingDifferentSourcescommand
(SET_SELECTION_STATE_BY_BINDING).Aftermaking
therowselection,userscansetafilterbychoosinga
pushbuttonthisfilterisappliedtotheAnalysisWebitem
andtheselectedrows.Formoreinformation,seeSetFilter
ValuesUsingDifferentSources.
Youcanalsouserowselectioninplanningapplicationsto
allowyoutoexecuteaplanningfunctionforoneormore
selectedrows.
Formoreinformation,seeRevaluatingPlanningFunctions
(withAnalysisWebItem)andDocumentation(with
AnalysisWebItem).

ColumnSelection(SELECT_COLUMNS)

Youusethisparametertospecifywhetherandhowmany
columnstheusercanselectatruntime.Youcanalsouse
thiscolumnselectionincommandssothatacommand
canalsobeexecutedwhencolumnsareselectedat
runtime.
Theoptionsavailablearethesameasthoseavailablefor
theRowSelectionparameter(seeabove).

DataBinding
Parameter

Description

http://help.sap.com/SAPhelp_nw73/helpdata/en/76/489d39d342de00e10000000a11402f/content.htm

5/9

11/18/2016

AnalysisBExWebApplicationDesignerSAPLibrary

Parameter

Description

DataProvider(DATA_PROVIDER_REF)

Youusethisparametertoassignadataprovidertothe
Webitem.TheWebitemobtainsthedataandmetadata
thatitneedstogeneratetheoutputandcommandsfrom
thisdataprovider.
Weadviseyoutofollowtheconventionssupportedby
WebApplicationDesignerwhenspecifyingnames:
Namescanbeamaximumof30charactersandconsistof
charactersAZ,09and_,butcannotstartorendwith_.
Followingtheseconventionsmakesiteasiertoupgradeto
subsequentSAPreleases.

AffectedData
Providers(LINKED_DATA_PROVIDER_REF_LIST)

Youusethisparametertocreatealistofdataproviders
thatallcommandsaresentto.
Foreachentryinthedataproviderlist,youselectadata
providerintheAffectedDataProviderparameter
(LINKED_DATA_PROVIDER_REF).
Notethatyoucannotcreatedataprovidersinthe
parameterdialogbox.Youhavetocreatethem
beforehand.

Paging
Parameter

Description

UseScrollBars

YouusethisparametertospecifywhethertheAnalysis

(USE_SCROLLBARS)

Webitemistocontainascrollbarforpagenavigation.
Thefollowingoptionsareavailable:
Automatic(AUTOMATIC)
Thesystemautomaticallyaddsascrollbarassoon
asthetablebecomestoolargeforthedisplayarea.
Enabled(ENABLED)
Thescrollbarisadded.
Youcanfindmoreinformationaboutscrollinginthe
Examplesection.
Disabled(DISABLED)
TheAnalysisWebitemisdisplayedwithoutscroll
bars.

PagingTypeforRows
(PAGING_TYPE_ROWS)

Youusethisparametertospecifythescrollinglogicinthe
rows.Thefollowingoptionsareavailable:
Automatic(AUTOMATIC)
Thesystemautomaticallyusesthemostsuitable
scrollinglogic,eitherbypageorbyrow.
ByPage(BY_PAGE)
Youcanscrollthroughtherowspagebypage.
ByRow(BY_ITEM)
Youcanscrollthroughtherowsrowbyrow.

http://help.sap.com/SAPhelp_nw73/helpdata/en/76/489d39d342de00e10000000a11402f/content.htm

6/9

11/18/2016

AnalysisBExWebApplicationDesignerSAPLibrary

Parameter

Description

PagingTypeforColumns

Youusethisparametertospecifythescrollinglogicinthe

(PAGING_TYPE_COLUMNS)

columns:Thefollowingoptionsareavailable:
Automatic(AUTOMATIC)
Thesystemautomaticallyusesthemostsuitable
scrollinglogic,eitherbypageorbycolumn.
ByPage(BY_PAGE)
Youcanscrollthroughthecolumnspagebypage.
ByColumn(BY_ITEM)
Youcanscrollthroughthecolumnscolumnby
column.

PagingAreaonBottomofTable
Visible(PAGING_AREA_BOTTOM_VISIBLE)

Youusethisparametertospecifywhethertheareafor
scrollingistobedisplayedatthebottomofthetable.

PagingAreaonTopofTable
Visible(PAGING_AREA_TOP_VISIBLE)

Youusethisparametertospecifywhethertheareafor
scrollingisdisplayedatthetopofthetable.

NumberofDataColumnsDisplayedatOnce
(BLOCK_COLUMNS_SIZE)

Youusethisparametertospecifythenumberofdata
columnstobedisplayedsimultaneously.Oncethis
numberisexceeded,ascrollingareaisinserted.

Note
Ifthevalueissetto0,thetableisdisplayedinits
completeform.Thesystemusesthesettingfor
restrictingthesizeoftheresultsethere.
Formoreinformation,seeSettingtheSizeRestriction
forResultSets
Thedefaultsettingforthisparameteris25.
ColumnsScrolledforEach
Step(BLOCK_COLUMNS_STEP_SIZE)

Youusethisparametertospecifythescrollinglogicyou
want:
Youcanspecifythenumberofdatacolumnstobescrolled
foreachstep.Thedefaultsetting"0"correspondsto2/3of
thedisplaycolumns.
Thevalueenteredcorrespondstothenumberofcolumns
scrolledthrough.

Tip

Ifyouenterthevalue"2",twocolumnsarescrolled
through.
Ifyouwanttoscrollthroughalldisplayeddatacolumns,
enterthesamevaluethatyouenteredfortheNumberof
DataColumnsDisplayedatOnceparameter
(BLOCK_COLUMNS_SIZE).

http://help.sap.com/SAPhelp_nw73/helpdata/en/76/489d39d342de00e10000000a11402f/content.htm

7/9

11/18/2016

AnalysisBExWebApplicationDesignerSAPLibrary

Parameter

Description

NumberofDataRowsDisplayedat
Once(BLOCK_ROWS_SIZE)

Youusethisparametertospecifythenumberofdatarows
tobedisplayedsimultaneously.Oncethisnumberis
exceeded,ascrollingareaisinserted.
Ifthevalueissetto0,thetableisdisplayedinitscomplete
form.Thesystemusesthesettingforrestrictingthesizeof
theresultsethere.
Formoreinformation,seeSettingtheSizeRestrictionfor
ResultSets
Thedefaultsettingforthisparameteris100.

RowsScrolledforEach
Step(BLOCK_ROWS_STEP_SIZE)

Youusethisparametertospecifythescrollinglogicyou
want:
Youcanspecifythenumberofdatarowsscrolledforeach
step.Thedefaultsetting"0"correspondsto2/3ofthe
displayrows.
Thevalueenteredcorrespondstothenumberofrows
scrolledthrough.

Tip

Ifyouenterthevalue"2",tworowsarescrolled
through.
Ifyouwanttoscrollthroughalldisplayeddatarows,enter
thesamevaluethatyouenteredfortheNumberofData
RowsDisplayedatOnce(BLOCK_ROWS_SIZE)
parameter.

CallContent
Parameter

Description

ExceptionVisualization(EXCEPTION_RENDERING)

Youusethisparametertospecifythedisplaytypefor
exceptions.Thefollowingoptionsareavailable:
Color(COLOR)(defaultvalue)
Symbol(SYMBOL)
SymbolandText(SYMBOL_TEXT)
TextandSymbol(TEXT_SYMBOL)

DocumentIconsfor
Metadata(DOCUMENT_ICONS_METADATA)

Youusethisparametertospecifywhetherlinksto
metadatadocumentsaretobedisplayed.

DocumentIconsforMaster
Data(DOCUMENT_ICONS_MASTERDATA)

Youusethisparametertospecifywhetherlinkstomaster
datadocumentsaretobedisplayed.

DocumentIconsforData(DOCUMENT_ICONS_DATA)

Youusethisparametertospecifywhetherlinksto
InfoProviderdatadocumentsaretobedisplayed.

AdjustingtheFormattingintheAnalysisGrid
Usingthethemeeditorintheportal,youcanadjusttheformattinginWebapplicationsthatisgeneratedbythe
UnifiedRenderingFramework.

http://help.sap.com/SAPhelp_nw73/helpdata/en/76/489d39d342de00e10000000a11402f/content.htm

8/9

11/18/2016

AnalysisBExWebApplicationDesignerSAPLibrary

TheThemeEditorprovidesyouwithvariousoptionsforformattingtheanalysisgrid,suchasdefiningthe
backgroundcolorinthedatacells,thehierarchylevelsandthetitleblocks.
Formoreinformation,seeUsingPortalMotivesinSAPNetWeaverBW.
NavigatingintheAnalysisGrid
FormoreinformationaboutusingtheAnalysisWebitemanditsfunctions,seeAnalyzingDatainanAnalysis
Grid(withNavigationandFilterPanes).

Example
UseScrollBars
Thefollowingcombinationofparametersoptimizestheuseofscrollbars.Whenyoumovethescrollbar,the
datarow/columnnumbersandthenumberofdatarows/columnsappear.Thedataisreadwhenyoureleasethe
mousebutton.Thescrollbarsthusallowquickandprecisenavigation.
Usingscrollbarsmeansthatitisnolongernecessarytodisplaythepagingareas
(PAGING_AREA_TOP_VISIBLEandPAGING_AREA_BOTTOM_VISIBLE).
YoucanusetheNumberofDataColumnsandRowsDisplayedparameters(BLOCK_COLUMNS_SIZEand
BLOCK_ROWS_SIZE)tofurtheroptimizetheappearanceofthescrollbar.
<bi:ANALYSIS_ITEMname="ANALYSIS_ITEM_1"designwidth="400"designheight="200">
<bi:DATA_PROVIDER_REFvalue="DP_1"/>
<bi:USE_SCROLLBARSvalue="ENABLED"/>
<bi:PAGING_AREA_BOTTOM_VISIBLEvalue=""/>
<bi:PAGING_AREA_TOP_VISIBLEvalue=""/>
<bi:BLOCK_COLUMNS_SIZEvalue="6"/>
<bi:BLOCK_ROWS_SIZEvalue="15"/>
</bi:ANALYSIS_ITEM>

C OPYR I GH T BY SAP SE OR AN SAP AF F I LI AT E C OM PAN Y. ALL R I GH T S R ESER VED . PR I N T ED F R OM SAP H ELP POR TAL.
(ht t p: / / help. s ap. c om )

http://help.sap.com/SAPhelp_nw73/helpdata/en/76/489d39d342de00e10000000a11402f/content.htm

9/9