Entering content frame

Object documentation List of Documents Locate the document in its SAP Library structure

Definition

Web item that displays a list of documents in the Web application. You can also Structure linkcreate new documents yourself in the Web application.

Use

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

Note

The documents for the characteristics that were set as the Document Properties in the Administrator Workbench appear automatically in the list.

Structure

The Web item This graphic is explained in the accompanying text List of Documents has the following structure:

·         Functions

You can also:

-         Structure linkCreate a New Document

-         Set whether or not the characteristics of the documents are to be displayed

-         Define whether the selection for the documents is to be displayed. If the selection is displayed, you can also change it so that you can look for documents in other areas. In order to be able to change the selection, the attribute Display Selection (see below) must be set accordingly.

·         Selection

The selection is the counterpart to the navigation block and shows the characteristics that are Document Properties and are contained in the basic data provider (query or query view), and their values.

Recommendation

If you have already inserted a navigation block into your Web template, you do not need the selection information in the list of documents if you want to see only those documents that refer to the numbers of the table.

The selection is adjusted dynamically depending on the navigation in the Web application. This means that the list of documents displays only those documents that refer to the requested data in the table. If the selection can be changed, you can also focus on the documents and, for example, display all the documents that refer to the InfoProvider.

You can set the following in the Web Application Designer using attributes:

¡        Whether you want to display the selection

¡        Whether or you can change the selection in the Web application

·         List of documents

The links to the documents are listed here in alphabetical order.

In addition to its general attributes, the List of Documents Web item has the following attributes:

Attributes

Description

Display Properties

(SHOW_PROPERTIES)

‘X’ = Yes, ‘  ’ = No

This attribute indicates if the document property is to be displayed. The document properties tell you about how the documents are assigned, for example base planning object 4711, month of May. The selection to which the document was restricted determines the assignment.

Note

If a document property is identical for all selected documents, this property is not displayed under the document link.

You define the initial display with the Document Properties attribute. Using the Properties on/off  button, you can toggle the display of the properties in the Web application.

Note

Furthermore, in the PROPERTY_LIST attribute you can set which additional document properties need to be displayed here.

 

Display Selection

(SHOW_CONTEXT)

' ' = can be changed, is not displayed at first

'N' = cannot be changed, is displayed at first

'X' = can be changed, is displayed at first

'0' = cannot be changed, is not displayed at first

With this attribute you can indicate whether the the selection conditions for the documents for the List of Documents Web item are displayed as well as whether these selection conditions are changeable.

Number of Rows in the Table

(BLOCK_SIZE)

With this attribute you can define the number of rows (document links and properties) that are displayed at one time. If there are not enough rows, an index for scrolling appears in the bottom row.

Maximum Number of Displayed Values

(MAXVALUES)

With this attribute you can define the maximum number of characteristic values to be displayed in the dropdown box of the selection.

Document Changeable

(DOCUMENTS_ARE_CHANGEABLE)

‘X’ = Yes, ‘  ’ = No

With this attribute you can define whether documents can be created, changed, or deleted.

Frame for Display

(TARGET_FRAME)

Here, you can specify an HTML frame in which the individual documents that you call from the list of documents is displayed.

Note

The HTML frame must be integrated in the Web template.

If you use the Web template within a frame set, you can also integrate the called-up document in another frame of this set.

If you do not define an HTML frame, the individual documents are displayed in separate windows.

Additional Properties

(PROPERTY_LIST)

Additional document properties that are displayed for each document displayed in the Web item. Here, you can set the following properties:

LAST_CHANGED_BY: Last person to make changes

LAST_CHANGED_AT: Change time

CREATED_BY: Creator

CREATED_AT: Creation time

CHECKOUT_USER: Editor

LANGUAGE: Language

You can find more information on using the List of Documents Web item and its functions under Structure linkUsing Documents in Web Applications.

 

Leaving content frame