Start of Content Area

Function documentation Using Documents in Web Applications Locate the document in its SAP Library structure

Use

You can add comments to and enhance the structured business data that you provide, for example in a table, with unstructured information such as texts, diagrams, and graphics. You do this using the Web items Single Document and List of Documents. You can access the existing documents for InfoProvider data, master data, and metadata from the context menu, using the Goto function.  You can also display document links to the content of cells in a report.

Prerequisites

·        You have the necessary authorization for displaying and editing documents. For more information, see Structure linkAuthorizations for Documents.

·        Individual Document and List of Documents Web items:

¡        You have created Structure linkdocuments in a Web application, in the Administrator Workbench or in the master data maintenance screen. You inserted the Web item single document or list of documents in the Web template when you published the Web application in the BEx Web Publisher.

¡        You are in the BEx Web Analyzer or in the Standard Web Template for Ad-hoc Analysis and have called the Notes function form the Data Analysis tab page.

Features

Single document

For a characteristic (such as business partner), you can add several documents (for example, route directions and a picture of the local office) for each value of the characteristic. Depending on the setting you made for the Document Display Type (IS_INPLACE) attribute in the Web Application Designer, the document is displayed either in the Web application or in its own window.

Value of the Document Display Type attribute (IS_INPLACE)

Display type

IS_INPLACE=“X“

The document is displayed in the Web application.

IS_INPLACE=” “

A link to the document is displayed in the Web application. This link takes you to the document which is then displayed in its own browser window.

List of documents

The List of Documents allows you to call up or create context-sensitive information for the InfoProvider data used in the Web browser.

You can search in the list of documents: See Finding Documents.

Additional Functions

You can get to other functions with the following pushbuttons:

·        Creating Documents

·        Properties On/Off

Here you are able to determine whether document properties are to be displayed or not. Depending on the settings you made for the Display Properties (SHOW_PROPERTIES) attribute in the Web Application Designer, the system either displays the properties for the documents or does not. You can change this initial setting again here.

·        Selection On/Off

Here you can 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 for the List of Documents Web item must be set accordingly.

See List of Documents for additional information about the selection.

Goto: Display documents, documents for navigation status

You can create new documents and display existing documents for various objects that have been created in the Administrator Workbench, master data maintenance, or in the Web application. You do this from the context menu by using the Goto function.

For more information, see Goto.

Document linksThis graphic is explained in the accompanying text

When documents exist for the content of a cell and the Display Document Links function is activated in the query properties, the system displays the This graphic is explained in the accompanying text symbol in the respective cell.  You then see immediately that a document exists for this cell. Click on This graphic is explained in the accompanying text. The document is displayed in its own browser window. Document links can be included in Table, Navigation Block, and Text Element Web items.

You can find additional information on Displaying Document Links in query properties:

·        In the Query Designer: Query Properties

·        In the Ad-hoc Query Designer: Query Properties

·        Locally in the context menu under Query Properties

You can also integrate links to documentation and links for calling the document browser from Structure linkTLOGO objects (InfoCube, Web template, query, and so on) directly into your Web template.

Example

Include a link for the online documentation on a BW object (including the generated documentation for the metadata repository)

<A href="DOC/METADATA/?page=BW_O_D&amp;ClassID=TMPL&amp;ID=MYOBJECT"> Metadata Documentation </A>

See also Structure linkDocument as Online Documentation and Structure linkTab Page: Online Documentation.

Include a link for the online documentation on a BW object (without the generated documentation for the metadata repository)

<A href="doc/meta/fldmeta/default?tlogo=TMPL&objnm=MYOBJECT"> Metadata Document</A>

Include a link to call the document browser (all documents for the metadata object are displayed)

<A href="DOC/BROWSER?document_class=meta&amp;TLOGO=TMPL&amp;OBJNM=MYOBJECT" target="_blank"> Document Browser </A>

Depending on the TLOGO-Object that you want to address, you can also use CUBE or ELEM, for example, instead of TMPL. You can find additional information about TLOGO objects under Structure linkTransport-Relevant Metadata Objects.

Note

·         Replace the MYOBJECT placeholder with the technical name of the relevant object. For a query, replace the placeholder with the unique ID (UID) of the query.

·         Use upper case letters, for example, TMPL, CUBE, and 0MJDOC_SEARCH, in the coding for describing the general TLOGO objects and for the technical names.

 

End of Content Area