Start of Content Area

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

Definition

Web item that allows you to display single 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 in any inplace format, 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. 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.

If you 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 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 Single Document 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 Single Document Web item is to be displayed with an icon that enables the Web item to be expanded and collapsed. For more information about 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.

Default URL (DEFAULT_PICTURE_URL)

You use this parameter to specify the default URL that is to be displayed if no document is found. You have already set the link to the document in Knowledge Management. You enter a KM path (or resource identifier), for example,

/irj/go/km/docs/documents/
mydocument/myComment.txt
.

Display Within Web Application (IS_INPLACE)

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

Display Document List Item (DISPLAY_LIST)

You use this parameter to specify whether the List of Documents Web item is to be displayed if more than one document qualifies for the Web item context.

Further Properties (PROPERTY_LIST)

You use this parameter to specify the properties of the document, which are 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)

Modified On (MODIFIED_ON) is the default value.

Behavior

Parameter

Description

Maintenance Possible (MAINTENANCE_POSSIBLE)

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

Edit Mode (EDIT_MODE)

You use this parameter to specify whether Web item Single Document can be processed directly in the Web application. The default value is Off.

Use as Target of Drag&Drop (DROP_TARGET)

You use this parameter to specify whether documents from Web items List of Documents and Analysis can be inserted into Web item Single Document by drag and drop and then directly displayed and edited there. The default value is On.

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)

      Reference (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.

Note

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. You then set this Web item property accordingly in the Web application. This allows you, for example, to include two Web items in the Web application, one of which displays the pictures and the other the description.

See also: Creating New Documents.

 

For more information about using the Single Document Web item and its functions, see Using Documents in Web Applications.

 

End of Content Area