Entering content frame

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

Definition

Web item allowing you to display single documents that you created in the Administrator Workbench or in master data maintenance for master data in the Web application.

Use

You can create the documents in different formats and versions (see Structure linkDocuments). You can add several documents such as route directions and a picture of the local office for each value of a characteristic, such as Business Partner. You can use the document type attribute to decide which document you want to display in the Web application.

Structure

As well as its general attributes, the Web item This graphic is explained in the accompanying text Single Document has the following specific attributes:

Attributes

Description

Document class (DOCUMENT CLASS)

‘MAST’ = master data (default setting)

‘TRAN’ = InfoProvider data

Document class for which documents are displayed (master data or InfoProvider data).

·        If you choose ‘MAST’ = master data, you have to specify a characteristic. The documents for the values of this characteristic are then displayed in the Web item.

·        If you choose ‘TRAN’ = InfoProvider data, the document that is relevant for the current navigational state is displayed in the Web item. This is worthwhile, for example,  if you have created a document (a report on the business area) for all combinations of month and business area and both of these characteristics are contained in the filter. The document is then always displayed in the Web item for the selected business area and month.

Document type (WWW_DOC_TYPE)

You can specify a type of document here. Only documents of this type are then displayed.

You can display several documents for the values of a characteristic at the same time in a Web application.

Example

For example, for the characteristic Customer, you can display a logo (in a Web item of the document type LOGO)and a sketch with directions (in a Web item of the document type MAP

If you create a new document or change an existing document, you can maintain the document type for this document. The various document types for the existing document are offered for you to choose from in the Web item.

Note

If you do not make any entries here, the system assumes that only one document is suitable for the Web item.

If this is not the case you get a message

-         That no document was found or

-         That the document is not unique (there is more than one)

Characteristic (IOBJNM)

Characteristic for which master data documents are displayed

Note

You need to select a characteristic in this attribute when you have chosen in the attribute Document Class (DOCUMENT_CLASS) the entry ‘MAST’ = master data:

Display frame (TARGET_FRAME)

HTML frame for displaying the document (IFrames are possible).

If you are working with frames in your Web application (including internal frames, or IFrames), you can divert the document output into a different frame instead of displaying it in the Web item itself. This is useful for documents that you cannot display in the Web item itself, such as Microsoft Word and PDF documents, but which you want to display immediately.

Recommendation

We recommend that you do not create a title for the Single Document Web item if you want to display the document in a different frame.

At the moment, you can display the following Structure linktypes of files in the Web item itself:

·        Images: image/jpeg, image/gif

·        Text: text/plain

·        Html: text/ html

Nesting depth of frame

(TARGET_FRAME_LEVEL)

Default setting “0”

This attribute specifies how many levels in the frame hierarchy have to be skipped to reach the display frame. Setting this attribute is particularly worthwhile when you are working with framesets.

·        With the default setting “0”, the display frames are addressed on the same HTML page.

·        With the setting “1”, frames are addressed that are defined on the same hierarchy level on which the frame that contains the current HTML page is also defined .

Display in same browser window (IS_INPLACE)

‘X’ = Yes, ‘  ’ = No

You can define if the single document is displayed

·        In the Web application (‘X’) or

·        As a link that the document calls up in a separate browser window (‘ ‘)

.

This attribute is interpreted only if the attribute TARGET_FRAME is empty.

You can only display documents in the same browser window (‘X’) for file types specified in the attribute TARGET_FRAME. The other file types are always displayed as a link.

Links to document display (LINK_TO_BROWSER)

‘X’ = Yes, ‘  ’ = No

You can use this attribute to determine whether you can link from the document to the general document display.

If the value is set to X, clicking on the picture displays all documents for the currently filtered characteristic value (or all documents for the characteristic master data, if no value is in the filter) in a separate browser window.

This attribute is interpreted only if the attribute TARGET_FRAME remains empty.

Default picture (DEFAULT_PICTURE_URL)

Absolute or relative URL for a picture. This picture is displayed in a Web item if no document has been found, or if the document is not consistent. Pictures from the MIME Repository can be selected here using a relative address.

You can find more information on using the Single Document Web item and its functionality under Structure linkUsing Documents in Web Applications.

 

Leaving content frame