Objects created by the SAP BW Data builderAdded by IBM on August 31, 2010 | Version 1 (Original)
|This builder creates variables and provides methods in a helper LJO.
This builder creates variables and provides methods in a helper LJO.
The SAP BW Data builder creates variables for the Command and Properties data (if they were provided hard-coded rather than with a runtime indirect reference). The builder also creates an xmlaResponse variable which holds the complete XMLA response after the executeMdx method has returned.
Each variable name is prefixed with the name given to the builder.
The SAPBWDataHelper LJO provides the methods described in Table 1 . For more information about their usage, refer to the sample models.
The executeMdx method needs to be called before any of the other methods are callable.
Table 1. SAPBWDataHelper LJO methods
|executeMdx||None||Executes the MDX expression and returns the complete XMLA response.|
|reset||None||Meant to be called by users that need to reset the builder before executing a query. |
The method resets the helper and causes it to immediately disconnect from the SAPBWAccess instance, re-initialize the values obtained from builder inputs, and prepare for a new query.
Calling this method causes the builder to refresh the values of all indirect references used as builder inputs. This action gives a user the means to update the values to which the indirect references point. Those updates are used by the builder the next time it executes its query by calling the executeMDX method.
The String that is used in response cells that contain no data.ValueCellName
Either FmtValue or Value depending on whether you wish the formatted data value or the raw data value from the data cell.
|Parses the response and returns only the table cell data and row labels in a form ready to be used by Dynamic Table or Data Page builders. |
Note: It is possible to call this method and massage the data with custom information or additional data before passing it through to the Table builder. The Dynamic Table builder operates solely on the runtime info and can be very flexible in those situations.
true or false to switch around the row/column axesremoveFirstRow
true or falseremoveFirstColumn
true or false removeLastRow
true or falseremoveLastColumn
true or false
|Parses the response and returns the table cell data formatted into a form ready to be used by the WebChart builder. Setting "flipAxes" true can be useful to get the alternative view on the data. |
The removeXXX args are useful if, for example, the first row of data is summary/total data and thus dwarfs the other row values. Removing it can give a more useful chart.
Note: It is possible to call this method and massage the data before passing it into a chart tool.
|getColLabelText||columnNumber||For any given column number (zero-based, corresponding to the table data) returns the col label from the Tuples/Tuple [i]/Member/Caption value.|
|getColLabels||None||Returns all column labels|
|getColumnCount||None||Returns the column count|
|getRowCount||None||Returns the row count|
|getRowLabelText||rowNumber||For any given row number (zero-based, corresponding to the table data) returns the row label from the Tuples/Tuple [i]/Member/Caption and Member /Caption values.|
If there is a Member Caption the result is returned in the form a-b where a is the Member/Caption and b is the Member /Caption.
|getRowLabels||None||Returns all of the row labels.|
|getRowLabelUName||loopCounterVarName, PagingAssistantName||For any given row number in the Dynamic Table rendering, returns the uname for that row. From the getLabels() result the Tuples/Tuple [i]/Member/UName and Member /UName values are determined. If there is a Member UName the result is returned in the form a__b where a is the Member/UName and b is the Member /UName.|
Pass in the name of the DynamicTable LoopCounter variable (for example, "dtLoopCounter"), and the name of the Paging Assistant (if any) used with the Dynamic Table. If there is no paging assistant being used, you may enter any name and it will be ignored. These values are used to calculate the current row number.
|get1BasedRowLabelUName||RowCounterVarName, PagingAssistantName||For any given row number in the Data Page rendering, returns the uname for that row. From the getLabels() result the Tuples/Tuple [i]/Member/UName and Member /UName values are determined. If there is a Member UName the result is returned in the form a__b where a is the Member/UName and b is the Member /UName. Data Page counters are 1-based, not zero-based like most other things.|
Pass in the name of the DataPage LoopCounter variable (for example, "RowCounterVar"), and the name of the Paging Assistant (if any). If there is no paging assistant being used, you may enter any name and it will be ignored. These values are used to calculate the current row number.
|getSAPBWAccess||None||Returns a SAPBWAccess object that can be used to more directly interact with SAP BW. |
You must call the "release" method on this object when you have finished with it. See example below.
Parent topic: SAP BW Data Access builder: wpf7