Show TOC Entering content frame

Object documentation Single Document Locate the document in its SAP Library structure

Definition

Web item that allows you to display single (non-migrated) documents that you created in the Data Warehousing Workbench or in master data maintenance, in the Web application.

 

Use

You can use the Single Document Web item to embed single documents of all formats inplace, without needing Frames or IFrames in the Web application.

 

Example

Example

You have a Web application that displays cost center data for the cost center manager. Every cost center manager performs this for their cost center, so the data is filtered according to cost center. The Web application always shows the data for the current month.

Assuming that you have stored a master data document for each cost center (for example, a short description of all people belonging to the cost center), you can configure the Web item so that this document is always displayed next to the table with the figures. The context-sensitive selection of the table ensures that each manager can only see the document for their cost center.

Assuming that each cost center manager must comment on the cost center expenses, you can additionally display this document for InfoProviders in a second Web item. The context-sensitive selection of the documents for InfoProvider data ensures that the appropriate document for the cost center/month combination is always displayed.

 

Structure

The following is a parameter list for the Single Document Web item, arranged according to the various parameter groupings.

Display

Parameter

Description

Width in Pixels (WIDTH)

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

Height in Pixels (HEIGHT)

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

Visibility (VISIBILITY)

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

With Tray (WITH_TRAY)

You use this parameter to determine whether the Single Document Web item has a symbol that enables 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 determine the maximum number of text lines for text documents.

Default Picture URL (DEFAULT_PICTURE_URL)

You use this parameter to determine the default URL that is displayed when no document is found. You set the link to the document in Knowledge Management. Enter a KM path (or Resource Identifier) here, for example, /documents/mydocument/myComment.txt.

Document Positioned (IS_INPLACE)

You use this parameter to determine whether the document is embedded in the Web application (On) or if only a link to the document is displayed (Off).

Display List (DISPLAY_LIST)

You use this parameter to determine whether the Document List Web item should be displayed if more than one document qualifies for the Web item context.

Property List (PROPERTY_LIST)

You use this parameter to determine the properties of the document to be displayed under the document. You have the following selection options:

     Modified on (MODIFIED_ON)

     Modified by (MODIFIED_BY)

     Created on (CREATED_ON)

     Created by (CREATED_BY)

The Modified On (MODIFIED_ON) option is the default value.

Behavior

Parameter

Description

Maintenance Possible (MAINTENANCE_POSSIBLE)

You use this parameter to decide whether it is possible to maintain the Single Document Web item. The default value is Off.

Data Connection

Parameter

Description

Data Provider
(DATA_PROVIDER_REF)

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

We recommend that you keep to the conventions supported by the Web Application Designer when specifying names: The name should be a maximum of 30 characters long and consist of characters “A-Z”, “0-9” and “_”, but cannot start or end with “_”. Adhering to these conventions facilitates the upgrade to future SAP releases.

Document Class (DOCUMENT CLASS)

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

     Meta (BW_OBJECT)

     Reference (CHARACTERISTIC)

     InfoProvider (MULTI)

For master data you must also enter the characteristic whose documents are to be displayed. For metadata you must also enter the meta object whose documents are to be displayed. In these instances, corresponding input help is available in the BEx Web Application Designer.

Document Type (WWW_DOC_TYPE)

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

This graphic is explained in the accompanying text

In the cost center example, you can assign two documents to each cost center, one document with pictures of employees and another with a description of the cost center. You can then classify all pictures as “PICTURE” and all descriptions as “DESCRIPTION”. To do this, you assign the value “PICTURE” or “DESCRIPTION” to the Document Type property of the document. Set this Web item property accordingly in the Web application. This allows you to, for example, include two Web items in the Web application, one of which displays the pictures and the other the description.

See also: Structure linkCreating New Documents.

 

For more information on the use and function of the Single Document Web item, see Structure linkUsing Documents in Web Applications.

 

Leaving content frame