Show TOC

 List of DocumentsLocate this document in the navigation structure

Definition

Web item that displays a list of documents in the Web application.

Use

The List of Documents Web item allows you to call or create context-sensitive information for data (master data, InfoProvider data, or metadata) used in the Web application. If you navigate in the Web application and, restrict a characteristic to a certain characteristic value, for example, the list of documents is adapted automatically. This means that only documents that are relevant for the restricted navigation status appear.

Note
Note Only characteristics that are set as a document property in the Data Warehousing Workbench are considered when selecting the documents for the InfoProvider data displayed for the most recent navigational state.

 

Example

You have a Web application that displays cost center data for the cost center manager. Each cost center manager requires this data for his/her cost center. The data is therefore filtered according to cost center. The Web application always displays the data for the current month.

Assuming you have stored a master data document for each cost center, you can configure the Web item so that this document is always displayed in addition to the table with the figures. The context-sensitive selection in the table ensures that managers can only see the document for their own cost center.

Assuming each cost center manager has to comment on the cost center expenses, you also display this document for InfoProviders in a second Web item. Context-sensitive selection of documents for InfoProvider data ensures that the right document is always displayed for the relevant cost center/month combination.

 

Structure

 

The following information lists the parameters for the Document List 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.

Height in Pixels (HEIGHT)

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

Visibility (VISIBILITY)

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

With Tray (WITH_TRAY)

You use this parameter to specify whether the List of Documents Web item is to be displayed with an icon that allows the Web item to be expanded and collapsed. For more information on this parameter, see Parameter Tray.

Internal Display

Parameter Description

Maximum Text Lines (MAX_TEXT_LINES)

You use this parameter to specify the maximum number of text lines for text documents.

Table Columns List (DOC_ITEM_TABLE_COLUMN)

You use this parameter to specify the table columns. You can select from the following options for the columns:

  • Name (Default)
  • Name (NAME)
  • Content (CONTENT)
  • Assignment (ASSIGNMENT)
  • Author (Author)

Author Column Content (COLUMN_AUTHOR_CONTENT)

You use this parameter to specify which information is to be displayed in the author column. You have the following selection options:

  • Author and Date (default value)
  • Author Only (Author)
  • Date Only (DATE)
  • Author and Date (BOTH)

Documents per Page (DOCUMENTS_PER_PAGE)

You use this parameter to specify how many documents are to be displayed on a page.

Table Header Visible (TABLE_HEADER_VISIBLE)

You use this parameter to specify whether the table header is to be displayed. The selection options are On and Off. The default value is Off.

Behavior

Parameter Description

Target frame (TARGET_FRAME)

Use this parameter to specify the HTML frame for displaying documents and document details. You have the following selection options:

  • New page (default value)
  • Default for this page (without) [ ] If you choose this setting, the HTML attribute target is not set and the default for the page is used.
  • Same frame [_self]
  • Whole page [_top]
  • New page [_blank]
  • Superordinate frame [_parent ]

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 adhere to the conventions supported by the 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 _. Adhering to these conventions makes it easier to upgrade to subsequent SAP releases.

Document Class (DOCUMENT CLASS)

You use this parameter to set the document class. You have the following selection options:

  • Metadata (BW_OBJECT)
  • Master data (CHARACTERISTIC)
  • InfoProvider (MULTI)

For master data, you also need to enter the characteristic whose documents you want to display. For metadata, you also need to enter the meta object whose documents you want to display. BEx Web Application Designer offers input help for these scenarios.

Document Type (WWW_DOC_TYPE)

You use this parameter to classify documents by assigning a freely selectable document type to them. If you set the parameter for the Web item, only the corresponding document types are displayed.

 

In the cost center example, you can assign documents to every possible combination of cost center and calendar month. Documents relate to either the revenue or expense of the cost center. You can classify the documents as "EXPENSE" or "REVENUE" by assigning the value "EXPENSE" or "REVENUE" to the Document Type property of the document. Set this Web item property accordingly in the Web application. For example, you can include two Web items in the Web application, one of which displays the documents for expenses and the other the documents for revenue.

 

You can find more information about using the List of Documents Web item in Using Documents in Web Applications .