Show TOC

 AnalysisLocate this document in the navigation structure

Definition

A Web item that allows you to display data in a table with analytical functions.

Use

The Analysis Web item displays the values of a data provider as a table in the Web application. The list geometries that are used in the BEx Analyzer are also supported here. Characteristics and structures can be displayed in both rows and columns.

Structure

The following information lists the parameters for the Analysis Web item, arranged according to the various parameter groupings.

Display

Parameter Description

Width in Pixels (WIDTH)

You use this parameter to specify the width of the Web item.

Full Width (FULL_WIDTH)

You use this parameter to specify that the value in the Width in Pixels (WIDTH) parameter is to be ignored and that the width is to be set to 100% instead. The full width depends on the width of the environment in which the Web item is embedded (for example, the width of a tab page on a portal page or in an iView).

Height in Pixels (HEIGHT)

You use this parameter to specify the height of the Web item.

Full Height (FULL_HEIGHT)

You use this parameter to specify that the value in the Height in Pixels (HEIGHT) parameter is to be ignored and that the height is to be set to 100% instead. The full height depends on the height of the environment in which the Web item is embedded (for example, the height of a tab page on a portal page or iView).

Visibility (VISIBILITY)

You use this parameter to specify whether the Web item should be visible in the Web application.

With Tray (WITH_TRAY)

You use this parameter to specify whether the Analysis Web item is to have an icon that allows the Web item to be expanded and collapsed. For more information about this parameter, see Parameter Tray.

Internal Display

Parameter Description

Display Mode

(ANALYSIS_ITEM_MODE)

You use this parameter to specify in which mode the Analysis Web item is to be displayed: The following options are available:

  • Automatic (AIM_AUTOMATIC)

    The system automatically selects the most suitable mode for the Analysis Web item.

  • Standard Analysis Grid (AIM_STANDARD_GRID)

    The default display is used to display the Analysis Web item.

  • Plain HTML (AIM_PLAIN_HTML)

    The Analysis Web item is displayed as plain HTML. This mode is particularly useful for displaying large amounts of data quickly or for accessing data using JavaScript. For example, you can hide the Analysis Web item in an application and access the data by using JavaScript.

    Note that the plain HTML display is no more than a pure display function for displaying the data. All data is displayed without formatting (such as colors or icons) in a table on one page, paging settings are not applied, and any interaction with the data (such as drag and drop, or sorting) is not supported.

Modification

(MODIFICATION)

This parameter provides a generic interface for changing the analysis Web item. This enables you to use similar options to those available in earlier releases with the Web Design API for Tables.

More information: Web Item Analysis: Parameter Modification.

Alternate Table Row Styles(ALTERNATE_STYLES)

You use this parameter to specify whether the styles for the odd and even table rows are to alternate and be displayed in a striped list.

Totals cells are not included in this display.

Display Repeated Texts(REPEATED_TEXTS_DISPLAYED)

You use this parameter to specify whether repeated texts or keys are to be displayed more then once or whether the repetitions are to be suppressed and the cells merged.

Display Scaling Factors(SCALING_FACTORS_VISIBLE)

You use this parameter to specify whether the scaling factors are to be displayed, if supported.

Row Header Visible (ROW_HEADER_VISIBLE)

You use this parameter to specify whether the row header area is to be displayed. The row header area displays the labels to the left of the data.

Column Header Visible(COLUMN_HEADER_VISIBLE)

You use this parameter to specify whether the column header area is to be displayed. The column headers display the labels above the data.

Data Cells Visible(DATA_CELLS_VISIBLE)

You use this parameter to specify whether the data cells are to be displayed.

Number of New Lines(NEW_LINES_COUNT)

You use this parameter to insert any required number of empty rows into the table. The default setting for this parameter is 0.

Note

Depending on the query settings, this parameter is used to insert columns instead of rows.

Position of New Lines(NEW_LINES_POSITION)

You use this parameter to specify the position at which the additional empty rows are to be inserted. You can select from:

  • Top
  • Bottom
    Note

    If the Number of New Lines parameter (NEW_LINES_COUNT) inserts columns instead of rows as a result of the existing query settings, Left and Right are the values to select from instead of the above values.

Data Column From(DATA_COLUMN_FROM)

You use this parameter to specify the data column from which the data is to be displayed. The default setting for this parameter is 1.

The setting for this parameter is separate to the setting for the Data Column To(DATA_COLUMN_TO) parameter.

Data Column To (DATA_COLUMN_TO)

You use this parameter to specify the data column up to which the data is to be displayed.

The default setting for this parameter is 0. If the value is 0, the system tries to display all columns. If there are too many, a scrolling area is inserted.

If the value is not 0, data is displayed up to the specified column only. No scrolling area is provided.

The setting for this parameter is independent of the setting for the Data Column From(DATA_COLUMN_FROM) parameter.

Data Row From(DATA_ROW_FROM)

You use this parameter to specify the data row from which the data is to be displayed. The default setting for this parameter is 1.

Data Row To(DATA_ROW_TO)

You use this parameter to specify the data row up to which the data is to be displayed.

The default setting for this parameter is 0. If the value is 0, the system tries to display all rows. If there are too many, a scrolling area is inserted.

If the value is not 0, data is displayed up to the specified row only. No scrolling area is provided.

Behavior

Parameter Description

Allow Navigation(INTERACTION_ALLOWED)

You use this parameter to specify whether navigation and other interactions should be possible in the Web application.

Only Hierarchy Navigation(ONLY_HIERARCHY_NAVIGATION)

You use this parameter to specify whether the context menu is to be hidden and whether expand and collapse options only are to be provided for the list.

Row Selection (SELECT_ROWS)

You use this parameter to specify whether and how many rows the user can select at runtime. You can also use this row selection in commands so that a command can also be executed when rows are selected at runtime.

You can choose from the following options:

  • None (NONE) (default value)

    Rows cannot be selected at runtime.

  • Single (SINGLE)

    Users can select one row at runtime.

  • Single with Commands (SINGLE_WITH_COMMAND)

    Users can select one row at runtime. When a row is selected, an activation or deactivation action is executed with a corresponding command.

    You can choose from the following parameters:

    • Activation Action (ACTIVATION_ACTION)
    • Deactivation Action (DEACTIVATION_ACTION)

    Using the command wizard, you can choose a command that is to be executed when the selected row is activated or deactivated. For more information, see Commands.

  • Multiple (MULTIPLE)

    At runtime, users can select multiple rows.

For example, you can associate the row selection with the Set Filter Values Using Different Sources command (SET_SELECTION_STATE_BY_BINDING). After making the row selection, users can set a filter by choosing a pushbutton; this filter is applied to the Analysis Web item and the selected rows. For more information, see Set Filter Values Using Different Sources.

You can also use row selection in planning applications to allow you to execute a planning function for one or more selected rows.

For more information, see Revaluating Planning Functions (with Analysis Web Item)and Documentation (with Analysis Web Item).

Column Selection (SELECT_COLUMNS)

You use this parameter to specify whether and how many columns the user can select at runtime. You can also use this column selection in commands so that a command can also be executed when columns are selected at runtime.

The options available are the same as those available for the Row Selection parameter (see above).

Data Binding

Parameter Description

Data Provider(DATA_PROVIDER_REF)

You use this parameter to assign a data provider to the Web item. The Web item obtains the data and metadata that it needs to generate the output and commands from this data provider.

We advise you to follow the conventions supported by Web Application Designer when specifying names: Names can be a maximum of 30 characters and consist of characters A-Z, 0-9 and _, but cannot start or end with _. Following these conventions makes it easier to upgrade to subsequent SAP releases.

Affected Data Providers(LINKED_DATA_PROVIDER_REF_LIST)

You use this parameter to create a list of data providers that all commands are sent to.

For each entry in the data provider list, you select a data provider in the Affected Data Provider parameter (LINKED_DATA_PROVIDER_REF).

Note that you cannot create data providers in the parameter dialog box. You have to create them beforehand.

Paging

Parameter Description

Use Scroll Bars

(USE_SCROLLBARS)

You use this parameter to specify whether the Analysis Web item is to contain a scroll bar for page navigation. The following options are available:

  • Automatic (AUTOMATIC)

    The system automatically adds a scroll bar as soon as the table becomes too large for the display area.

  • Enabled (ENABLED)

    The scroll bar is added.

    You can find more information about scrolling in the Example section.

  • Disabled (DISABLED)

    The Analysis Web item is displayed without scroll bars.

Paging Type for Rows

(PAGING_TYPE_ROWS)

You use this parameter to specify the scrolling logic in the rows. The following options are available:

  • Automatic (AUTOMATIC)

    The system automatically uses the most suitable scrolling logic, either by page or by row.

  • By Page (BY_PAGE)

    You can scroll through the rows page-by-page.

  • By Row (BY_ITEM)

    You can scroll through the rows row-by-row.

Paging Type for Columns

(PAGING_TYPE_COLUMNS)

You use this parameter to specify the scrolling logic in the columns: The following options are available:

  • Automatic (AUTOMATIC)

    The system automatically uses the most suitable scrolling logic, either by page or by column.

  • By Page (BY_PAGE)

    You can scroll through the columns page-by-page.

  • By Column (BY_ITEM)

    You can scroll through the columns column-by-column.

Paging Area on Bottom of Table Visible(PAGING_AREA_BOTTOM_VISIBLE)

You use this parameter to specify whether the area for scrolling is to be displayed at the bottom of the table.

Paging Area on Top of Table Visible(PAGING_AREA_TOP_VISIBLE)

You use this parameter to specify whether the area for scrolling is displayed at the top of the table.

Number of Data Columns Displayed at Once

(BLOCK_COLUMNS_SIZE)

You use this parameter to specify the number of data columns to be displayed simultaneously. Once this number is exceeded, a scrolling area is inserted.

Note

If the value is set to 0, the table is displayed in its complete form. The system uses the setting for restricting the size of the result set here.

For more information, see Setting the Size Restriction for Result Sets

The default setting for this parameter is 25.

Columns Scrolled for Each Step(BLOCK_COLUMNS_STEP_SIZE)

You use this parameter to specify the scrolling logic you want:

You can specify the number of data columns to be scrolled for each step. The default setting "0" corresponds to 2/3 of the display columns.

The value entered corresponds to the number of columns scrolled through.

Tip  

If you enter the value "2", two columns are scrolled through.

If you want to scroll through all displayed data columns, enter the same value that you entered for the Number of Data Columns Displayed at Once parameter (BLOCK_COLUMNS_SIZE).

Number of Data Rows Displayed at Once(BLOCK_ROWS_SIZE)

You use this parameter to specify the number of data rows to be displayed simultaneously. Once this number is exceeded, a scrolling area is inserted.

If the value is set to 0, the table is displayed in its complete form. The system uses the setting for restricting the size of the result set here.

For more information, see Setting the Size Restriction for Result Sets

The default setting for this parameter is 100.

Rows Scrolled for Each Step(BLOCK_ROWS_STEP_SIZE)

You use this parameter to specify the scrolling logic you want:

You can specify the number of data rows scrolled for each step. The default setting "0" corresponds to 2/3 of the display rows.

The value entered corresponds to the number of rows scrolled through.

Tip  

If you enter the value "2", two rows are scrolled through.

If you want to scroll through all displayed data rows, enter the same value that you entered for the Number of Data Rows Displayed at Once (BLOCK_ROWS_SIZE) parameter.

Call Content

Parameter Description

Exception Visualization (EXCEPTION_RENDERING)

You use this parameter to specify the display type for exceptions. The following options are available:

  • Color (COLOR) (default value)
  • Symbol (SYMBOL)
  • Symbol and Text (SYMBOL_TEXT)
  • Text and Symbol (TEXT_SYMBOL)

Document Icons for Metadata(DOCUMENT_ICONS_METADATA)

You use this parameter to specify whether links to metadata documents are to be displayed.

Document Icons for Master Data(DOCUMENT_ICONS_MASTERDATA)

You use this parameter to specify whether links to master data documents are to be displayed.

Document Icons for Data(DOCUMENT_ICONS_DATA)

You use this parameter to specify whether links to InfoProvider data documents are to be displayed.

Adjusting the Formatting in the Analysis Grid

Using the theme editor in the portal, you can adjust the formatting in Web applications that is generated by the Unified Rendering Framework.

The Theme Editor provides you with various options for formatting the analysis grid, such as defining the background color in the data cells, the hierarchy levels and the title blocks.

For more information, see Using Portal Motives in SAP NetWeaver BW.

Navigating in the Analysis Grid

For more information about using the AnalysisWeb item and its functions, see Analyzing Data in an Analysis Grid (with Navigation and Filter Panes).

Example

Use Scroll Bars

The following combination of parameters optimizes the use of scroll bars. When you move the scroll bar, the data row/column numbers and the number of data rows/columns appear. The data is read when you release the mouse button. The scroll bars thus allow quick and precise navigation.

Using scroll bars means that it is no longer necessary to display the paging areas (PAGING_AREA_TOP_VISIBLE and PAGING_AREA_BOTTOM_VISIBLE).

You can use the Number of Data Columns and Rows Displayed parameters(BLOCK_COLUMNS_SIZE and BLOCK_ROWS_SIZE) to further optimize the appearance of the scroll bar.

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

<bi:DATA_PROVIDER_REF value="DP_1" />

<bi:USE_SCROLLBARS value="ENABLED" />

<bi:PAGING_AREA_BOTTOM_VISIBLE value="" />

<bi:PAGING_AREA_TOP_VISIBLE value="" />

<bi:BLOCK_COLUMNS_SIZE value="6" />

<bi:BLOCK_ROWS_SIZE value="15" />

</bi:ANALYSIS_ITEM>