The documentation may have changed since you downloaded the PDF. You can always find the latest information on SAP Help
Portal.
Note
This PDF document contains the selected topic and its subtopics (max. 150) in the selected structure. Subtopics from other structures are not included.
2016 SAP SE or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose
without the express permission of SAP SE. The information contained herein may be changed without prior notice. Some software products marketed by SAP
SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are
provided by SAP SE and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP
Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set
forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional
warranty. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE in
Germany and other countries. Please see www.sap.com/corporate-en/legal/copyright/index.epx#trademark for additional trademark information and notices.
Table of content
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 1 of 22
Table of content
1 Documents
1.1 Document Classes
1.2 Documents as Online Documentation
1.3 Processing Documents in the AWB Documents View
1.4 Processing Documents in the Documents Screen
1.5 Creating Documents
1.6 Exporting Documents
1.7 Hyperlinks to Documents
1.8 Searches in Documents
1.9 Managing Documents in BW
1.9.1 Retrieval: Search Server Relation Monitor
1.9.2 Tab Page: Content Repository
1.9.3 Tab Page: Indexing for a Search
1.9.3.1 Setting up Indexes for Initial Searches
1.9.3.2 Generating Metadata Documentation Initially
1.9.4 Tab Page: Generated Properties
1.9.4.1 Characteristic Is Document Property
1.9.5 Tab Page: Online Documentation
1.9.6 Valid File Types
1.9.6.1 Editing Valid File Types
1.10 BAdIs for Use in Documents
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 2 of 22
!--a11y-->
1 Documents
Use
With BW objects, you can add, link to, and search in one or more documents in various formats, versions, and languages.
Integration
The following graphic gives you an overview of the components:
You can get an overview of the document model in the Document Modeling Workbench . See Managing the BW Document Administration.
The individual files can be stored on a SAP database or using a HTTP interface on an external content server.
Prerequisites
Give users the authorization to display or edit documents. See
For more information on the settings that you need to make before you start a project, see BW Document Management.
Functions
You can add documents for metadata, master data, and InfoProvider data. There are three corresponding document classes. See Document Classes
In order to create or edit a document for an individual BW object, you have the following options in your BW system:
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 3 of 22
You can edit documents from the maintenance transactions for metadata and master data from the Documents screen.
You can edit documents in the Documents functional area of the Administrator Workbench.
The same functions for creating, importing, editing, exporting, and displaying documents are available on both interfaces. Furthermore, there are also
special features and restrictions:
The Documents screen gives you a button for displaying the online documentation if it concerns documents for metadata objects.
In the Documents functional area of the Administrator Workbench, you can display and edit documents from all document classes by using different
search criteria. Otherwise, you can go to the document administration.
You can find additional information under Editing Documents in the Documents Screen and Editing Documents in the AWB Documents View.
You can create documents in different formats. You can find additional information about the BW system for SAP-delivered, valid file types under Valid
File Types.
You can manage documents in different languages, by
creating a document in a language
editing the document online or checking-it out of the system to edit it offline
creating a target-language version of a document that you have edited and saved online or checked-out to edit offline and checked-in again
Since the language is a property of the physical document, the system gets the right document for the language in which you logged on to the system.
The system checks the language first:
a. If there are several documents in the logon language, the newest document is displayed.
b. If there is no document in the logon language, the newest document is displayed in the language from the user settings or, if no language is selected
in the user settings, the newest document in the systems standard language is displayed.
c. If there is no document in the specified languages, the newest document existing in the system is displayed.
You can set links between documents that have been written in formats that support hyperlinks. For more information, see Hyperlinks to Documents.
In order to display existing documentation, you have different search options:
by text strings in the documents
by document properties (see Document Classes)
For more information see Editing Documents in the AWB-View.
You can index documents for BW objects for the full-text search (see Search in Documents). You can find additional information under Tab Page: Indexing
for a Search.
!--a11y-->
Use
The following overview shows you the BW objects that you can choose from, and the corresponding document classes (with a typical example). For each
document class, there are typical examples of where the different documents are used.
BW Object
Document Class
Metadata
META
Aggregates
Update Rule
InfoCube
InfoObject
InfoPackage
InfoSet
InfoSource
ODS Object
Query (including variables, structures, restricted and calculated key
figures).
Reporting Agent Scheduling Packet
Reporting Agent Settings
Web Item
Web Template
Master Data
The user can choose a document that he or she wants to display in the online
documentation. See Documents as Online-Documentation.
MAST
Characteristic value
Example for documents for master data:
Screens for personnel numbers
Descriptions and technical specifications of materials
Original documents for order forms
Documentation for version (target/actual budget)
InfoProvider Data
TRAN
were poor in May, because ..., In May the following key figures were interesting:
Delivery quantity Explanation ..., Outstanding payments - ...)
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 4 of 22
See also:
Documents for planning objects in BW-BPS
Structure
The following overview shows you the BW objects that you can choose from, and the corresponding document classes (with a typical example).
Document Class
Document properties
META
You can set one value for each of the following document properties:
Object type
Object name
MAST
You can set one value for each of the following document properties:
Characteristic
Characteristic value
TRAN
You can set one value for each of the following document properties:
InfoProviders
Query
For the following document property, you can set more than one value:
Key figure
the characteristics that have been designated as properties of documents are also
displayed (sorted alphabetically). For these characteristics, you can set more than
one value per document property.
You have to activate any characteristics that you want the system to display in the
maintenance screens for InfoProvider data documents. You do this in the
maintenance screens for characteristics on the
Integration
Document properties are given by default.
as search criteria in the Documents function area of the Administrator Workbench
See Processing Documents in the AWB Documents View.
as logical document properties whenever you create a document You can use document properties to assign documents to a BW object. See Creating
Documents
!--a11y-->
Use
Online documentation is usually displayed as F1 Help for the object to which it is assigned.
Online documentation is displayed in the following situations:
In the Documents screen for the affected metadata object, by choosing the
Display Documentation pushbutton. The F1 Help is displayed in the Web
browser.
In the Administrator Workbench, by opening the F1 Help for a BW object.
By selecting a BW object from the metadata repository. The online documentation is displayed under the header Documentation .
You open a query in the BEx Analyzer or in the Web browser, or you call up a Web application. You can display the online documentation for a
characteristic using
or
Note that you first see the document symbols if you have chosen the following setting in the query properties: Tab page Display Display
Options Display Document Links . For more information, see
Query Properties
Structure
The online documentation for a BW object is made up of the following parts:
1. The first part contains general information about the object, such as
Object type (with symbol) and name of the object
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 5 of 22
In a generated version of the online documentation, you can use the search function (see Search in Documents). You can find additional
information about the necessary settings for managing the document administration under Tab Page: Indexing for a Search.
If the user has not written any online documentation, the system displays the Business Content documentation.
To include SAP Content documentation in the online documentation generated for metadata objects, it must be installed in plain html http
format for static help and using a Web server. The Content documentation can then be read by the Web server from any front end platform
using the http protocol, and displayed in a Web browser.
You can find additional information about maintaining setting variants for online help (transaction SR13) in the Business Information Warehouse
Implementation Guide (IMG), under the node General BW Settings Settings for Displaying SAP Content Documentation.
- If there is no Business Content documentation for the object, the system does not display a text. If there are links to other documents, these links are
displayed.
3. The third part contains links to the online documentation of dependent objects.
Integration
BW documents for metadata objects as http service
The document designated as online documentation (or the only document) for a metadata object can be addressed with a logical URL. This URL has to follow
the following schema:
<Protocol>://<Server>:<Port>/sap/bw/doc/meta/fldmeta/default?tlogo=<Objecttype>&objnm=<Name of the Object>
The document is displayed without the generated documentation for the metadata repository.
!--a11y-->
Procedure
1. You are in the Documents function area of the Administrator Workbench.
2. On the left-hand side of the screen, the data types for which you are able to process documents are displayed:
Metadata
Master Data
InfoProvider Data
On the right-hand side of the screen, the document class that has been processed most recently and the most recently made selection are
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 6 of 22
displayed by default.
3. You use the
Show Me Documents from function to display the available documents.
All the available document properties have the default value *, meaning that the system searches through all of the values.
We recommend that you restrict the selection before you display the documents. You can use specific document properties as search criteria,
or you can search the documents for a particular text string.
For more information on document properties, see Document Classes.
Note the following special features when navigating in the display screen for documents for InfoProvider data objects: Using
Settings , you
can restrict the number of displayed characteristics. You get to the Change User Settings dialog box. Choose Only Offer the Characteristics
from the InfoProvider or Offer All Characteristics . In the list in the lower area of the screen, you can also add or remove individual document
properties.
If you want to search for documents containing a particular text, type the text that you want to search for into the input field labeled Containing the
Following Text .
If you have used document properties of the object to restrict the search, the system searches for documents that match the selection that
you made in the fields and the text that you specified.
For more information on restricting a search, and other special features of the search function, including the Altavista full-text syntax search,
see Searches in Documents.
Do not activate the
Show Me Documents from function, until you have finished making all your restrictions and changes in the display
screen.
4. The system shows you a list of documents for the restrictions you have made.
The difference between this list and the list of documents on the Documents screen is that this list has an extra column containing the names of the
objects for which each of the documents has been created.
If all of the documents in the list belong to the same object, this Object Name column is not displayed.
Just as in the Documents screen, there are various functions available. You access these functions
using the pushbuttons in the toolbar for the list of documents
in the context menu of an individual document
When you create a document, only the fields for which you have made a selection are filled with default values on the Logical Document
Properties tab page. You are, however, able to make further restrictions.
!--a11y-->
In the Documents function area of the Administrator Workbench, you can create, edit, and search documents in all document classes (see
Processing Documents in the AWB Documents View).
Integration
Depending on the type of BW object and the respective document class (META or MAST), you arrive at the Documents screen in one of the following ways:
from the object maintenance of a metadata object or a master data object
You are in the maintenance of a metadata object. Choose
You have selected a characteristic value in the master data maintenance (see also
Master Data Maintenance). Choose
Characteristic Value or Goto Documents .
from the Modeling functional area of the Administrator Workbench
a. Choose the object tree and the object for which you want to create one or more documents.
b. Select the BW object and choose Edit Documents .
Documents for
Functions
On the Documents screen, the following functions are available as pushbuttons on the toolbar:
Function
Pushbutton
Information
Display Documentation
Create
Import
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 7 of 22
Creating Documents
Display
Edit
Edit Documents.
Properties
Detail
Delete
Sort Ascending
Sort Descending
Search
The following functions are available from the context menu of each document:
Function
Information
Preview
Displays the contents of the document in the lower part of the screen.
Display
Loads the document into a separate window in the application, in which it was written.
Detail
Special Functions
Back and
Forward pushbuttons
Preview
Edit Document
Displays the contents of the document in the lower The application, in which the document was written, is
part of the screen
opened. Make your desired changes.
When you save the document, you decide whether you
want to overwrite the old version, or create a new
version.
When you close the application, the document is
checked-in automatically.
Versions
shows all physical documents (versions) for the
logical document
Where-used list
menu).
In the ALV grid control, you can use the standard
functions ( Sort, Find, Set Filter, Print, View, Export,
Choose Layout ).
For more information see
Used objects
Properties
User
Documentation .
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 8 of 22
Technical information:
Logical document
Physical document
Detail information
Delete
!--a11y-->
Procedure
1. Choose
Create. You get to the Create New Document dialog box.
2. Type the required data onto the tab pages.
Tab page
Information
General
The name must be unique for all the documents in a document class.
Description
You determine the permitted file types in the document management section of
the Administrator Workbench. You can find additional information under Editing
Valid File Types.
Select the MIME type that you want to use, and choose
Log.Doc.Property
Transfer .
The particular BW object that you have chosen, or the extent to which you have
restricted the number of BW objects in the selection in the Documents functional
area of the Administrator Workbench, determines if and how many of the fields are
filled with default values. Input help is available for some of these input fields.
The individual document classes have the following logical document properties:
Metadata:
Object name
Object type
Online documentation: You determine the status of the documents by
choosing yes or no from the dropdown menu. You can choose Yes
only for one document.
Hide name: If you set this property, the technical name of the object is
not shown in reporting; only the document description is displayed.
This is especially useful for documents that had already been created for
BW Release 3.0 from reporting, because the system for these documents
had suggested a GUID as the technical name of the document. If you
set the Hide Name property afterwards, this GUID will no longer be
displayed for the reporting user.
Master data:
Characteristic
Characteristic value
Document type (user-defined)
Hide Name (see above)
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 9 of 22
InfoProvider data:
InfoProviders
Query
Key figure
All characteristics that are indicated as Characteristic is Document
Property
Hide Name (see above)
Technical Information
Document Class
Logical Document Class
You are not required to make any entries.
For more information on document classes and properties, see Document Classes.
3. You choose the
Start Editor function to begin editing the document. The application opens according to the MIME type that you have selected.
4. Save the document in the application.
5. Close the application.
Result:
The new document is created on the server.
See also:
You can also create new documents in Web applications with the Web item List of Documents. You can find additional information under
Documents.
Creating New
!--a11y-->
Procedure
You click on the
There are the following options. The one you choose depends on what you want to do with the document.
Exporting a copy of a document
1. You choose the Export as Copy option if you want to make a copy of the document and store in on your hard drive.
This takes you to the Save as dialog box.
2. Type in the required data (file name, storage location).
3. Save your entries.
The file with the copy of the document is stored in the location that you specify.
Exporting a locked document
1. If you want to check-out a document and process it locally, choose the Export with Lock function.
This takes you to the Save as dialog box.
2. Type in the required data (file name, storage location).
3. Save your entries.
The document is stored in the location that you specify, and you are able to process it locally.
4. When you check-out a document, the following changes occur in the Administrator Workbench:
The name of the user, who has checked-out the document is displayed in the Processed By column of the document list.
Now, when you click on the
Edit pushbutton, you are able to call the Import Version and Remove Lock functions in addition to the Export as
Copy function:
5. You choose the Import Version function if you want to import the document that you checked-out previously. This takes you to the Open dialog box.
a. Type in the required data (file name, storage location).
b. Choose Open . You are taken to the Create Document Version dialog box.
c. If you want to overwrite the old version , put a checkmark in the appropriate checkbox.
Otherwise, the system creates a new version.
The system suggests the Language of the old version as the default value for the new version. You are able to change these values, if you want to.
d. Save your entries.
6. If you do not want to copy over the document that you have edited locally, choose the Remove Lock option.
The document in the BW system retains the status it had before the export.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 10 of 22
!--a11y-->
Use
There are the following types of links:
1. You need the following information if you want to create a link from outside of the BW system to a document belonging to a BW object:
Server (meaning the SAP Web application server, not the ITS)
Port
Name of the document that you want to link to
From this information, you get the following URL:
Document Class
URL
Metadata
http://<Server>:<Port>/SAP/BW/DOC/META/FLDMETA/<Document Name>
Master Data
http://<Server>:<Port>/SAP/BW/DOC/MAST/FLDMAST/<Document Name>
InfoProvider Data
http://<Server>:<Port>/SAP/BW/DOC/TRAN/FLDTRAN/<Document Name>
Make sure that the name of the document is unique within the document class.
2. You can use relative links to link documents that belong to one and the same document class.
To link to document 02, add the HTML code to document 01 according to the following pattern:
<a href = "Name of document 02"> Text </a>
3. You can use this method of modifying the HTML code to link documents that do not belong to the same document class.
For example, if you want to link document 01 to document 02, and document 01 belongs to the META document class while document 02
belongs to the TRAN document class, add the HTML code to document 01 as follows:
<a href = "../../TRAN/FLDTRAN/"Name of document 02"> Text </a>
!--a11y-->
We recommend that from time to time (once a week, perhaps) you generate the documents in the background, and check them in as hidden
documents. This enables you to run searches. Note: These documents may not be quite up-to-date, depending on the time of generation, when
using this method. You can find additional information under Tab Page: Indexing for a Search.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 11 of 22
Function
Syntax
Information
Search by sentences
"..."
For example, to search for a recipe for spaghetti bolognese without meat, type in:
+recipe +spaghetti sauce meat.
Asterisk as a wildcard
AND
OR
AND NOT
For example, to find all the documents in which the words sport and football appear near one another,
type:
Sport NEAR Football
()
See also:
In Web applications, the List of Documents Web item provides you with a full text search function. For more information, see
Finding Documents.
!--a11y-->
Administration function to
Determine the storage type as a physical storage medium for the documents that you want to create.
Put documents (including online documentation for metadata objects) into the indexing queue, and schedule the processing of this queue as a regular job,
so that the documents are included in the search.
Check whether the properties for the documents for InfoProvider data have been generated from the characteristics that they were supposed to be
generated from.
Integration
Document management applies to documents from all the document classes. These functions are needed and useful
at the start of a project,
after the BW system has been upgraded,
and during a project
Prerequisites
To be able to use the indexing and search functions in the online documentation, you need change some settings after the first installation. You can find
additional information in the Business Information Warehouse Implementation Guide (IMG), under the node Documents for BW Objects
Installation of TREX
Creation of an RFC Destination in the BW System
Creation of a Search Server Relation
To include SAP Content documentation in the online documentation generated for metadata objects, it must be installed in plain html http format for static
help and using a Web server. You can find additional information in the Business Information Warehouse Implementation Guide (IMG), under the node
General BW Settings Settings for Displaying SAP Content Documentation.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 12 of 22
Functions
Different functions from the following areas are available on the tab pages:
Tab Page:
Tab Page:
Tab Page:
Tab Page:
Content Repository
Indexes for Searches
Generated Properties
Online Documentation
Information
!--a11y-->
We highly recommend using the search server relation monitor in the following instances,
If you have difficulty with an index category (for example, when executing the RSTIRIDX program)
If you are no longer using an index category and their indexes, and you, therefore, want to delete them
If you want to change or enhance your settings in the Business Information Warehouse Implementation Guide (IMG)
Integration
If you are in the Managing the BW Document Administration screen, you use Search Server Relations to get to the Retrieval: Search Server Relation
Monitor (transaction SRMO) screen.
Prerequisites
Within the scope of the new installation, you have made the following settings:
Creation of an RFC Destination in the BW System
Creation of a Search Server Relation
You can find additional information about activities having the same names in the Business Information Warehouse Implementation Guide (IMG) under
Documents for BW Objects.
Functions
Tab Page: Search Server Relation
The table shows the Search Server Relation (SSR) created in the implementation guide for the BW system. This Search Server Relation has to be indicated as
a standard SSR in the Default SSR column.
Tab Page: RFC Destinations
The table shows the RFC destination created in the implementation guide for the BW system. However, for each Search Server Relation there is one RFC
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 13 of 22
C:/Program Files/SAP/SAPTREX/index.
Set Data Path
You arrive at the Setting the Search Engine Data Path (Directory) dialog box. Under New Data Path , you can specify a new path with a maximum
of 255 characters.
Display BACKUP Path
You arrive at the Display Search Engine Backup Path dialog box. . The system displays the search engine backup path set.
C:/Program Files/SAP/SAPTREX/backup
Set BACKUP Path
You arrive at the Setting the Search Engine Backup Path (Directory) dialog box. Under New Backup Path , you can specify a new path with a
maximum of 255 characters.
Tab Page: Index Category (Index)
To display an index category, specify the index category ID, which is the 32-place GUID, in the Index Category field. Input help is available.
Choose
Display . The system shows the index category settings and activates the functions in the toolbar. The following tables are displayed in the lower
screen area:
Created indexes
Document Attributes
Index Category Attributes
Note that deleting an index category cannot be reversed, and that re-indexing can take a large amount of time in some cases.
!--a11y-->
Use
Depending on the requirements of your application, we recommend that you decide, before you start a project, which is the best storage category to use.
SAP database (R/3 database)
Administration effort: Minimal
Access times: With large numbers of documents, and individual users, accessing the documents (over the Net) is slower than if you use a HTTP content
server.
HTTP Content Server
Administration effort: High
Access time: The HTTP content server can be implemented in stages, and the caching method means that you can access documents quickly, even with
very large number of documents, and lots of different users.
You are able to change the content repository only if there are no documents in the selected document class.
If documents do exist, you will no longer be able to access them, once you change the storage category.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 14 of 22
If, for example, you want to be able to transfer these documents to the HTTP content server, you have to first move the documents from the
SAP database to the HTTP content server. In this case, contact your SAP consultant, or SAP directly.
Structure
The settings for each document class are displayed in the Content Repository tab page:
Storing documents for metadata
Storing documents for master data
Storing documents for InfoProvider data
The system shows you the settings for the following fields:
Field
Information
Content Repository
Only the first two types are valid for the Business Information Warehouse
You use the
Overview screen.
Storage category
In this field, the system displays the selected storage category, R/3 database, or
HTTP content server.
If you want to change the storage category, click on the
Content Repository
Maintenance pushbutton.
Number of logical documents
!--a11y-->
Use
The following preconditions must be met before you are able to search in the documents belonging to BW objects:
1. The index must be switched on.
2. The program for indexing (RSTIRIDX) must run as a regular job.
If a document has been placed in the index queue and has been processed by this queue, it is included in the search.
Structure
The following fields and functions are on the Indexing for a Search tab page:
Status display
Field
Information
Indexing status
Help
Displays a help text for the Indexing for a Search tab page (in the performance
assistant).
Index jobs
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 15 of 22
Field
Information
Execution date
You get to the Start Time dialog box. Specify that you want the program for
indexing to run as a regular job. This ensures that the index queue is processed
regularly, All the words contained in the documents are included in the index. It
handles documents in all languages. For each language, an individual index is
built.
We recommend that you schedule the job to run daily (for example, along with
loading jobs for BW).
Index Job Overview
You get to the Simple Job Selection screen. The job name field contains the
name of the indexing job.
You can select the jobs that need to be displayed in the overview, as well as
restrict the Job Status , Job Start Condition , and Job Step . To display a
scheduled job, you have to choose the Planned option under the Job Status .
Under
Choose
Execute . You get to the Job Overview screen. You can find
Additional Functions
Field
Re-Index All Documents
Information
You get to the Re-Index a Class or a Document Area screen.
You can re-index all of the documents in a document class, and not just the
documents that are in the index queue. The result of the re-indexing process is
similar to that of a reinitialization process. All documents are placed in the queue.
This is necessary, for example, if you have edited documents without having the
index switched on.
We recommend that you re-index after the BW system has been upgraded to BW
Release 3.0, because until this point the search function has not been available
for documents for metadata.
Monitoring the Indexed Documents
Refresh function.
and
not the following settings are available in each of the document areas:
Index possible
Auto-index
DocArea activated
The system displays the Attributes That Can Be Indexed , the Valid IndexCategory Attributes , and the Index Category in tables of the same name.
Tools Tab Page:
You need specialist knowledge to use this function.
Index/De-Index : You use the
Trigger Process function to either start the index
queue immediately or schedule it to run in the background. You get a report on the
D e/Indexing of Documents That Have Been Checked in.
Under the header Single Actions , you are able to select individual documents that
you want to either add or remove from the index.
Under the header Mass Actions , you are able to re-index a whole class or a whole
document area (restricted to the selected language).
Under the header Extras , you are able to
use the
Test Search function to find documents
use the
Problem Cases function to display documents with which
there are problems
use the
Indexed Documents function to find out which documents
have been indexed already
use the
Scheduled Documents function to find out which documents
are still in the index queue.
Under the header Information About , you can
use the input help to select a document area, and click on the
DocArea function to get information about the
Document classes and they ability to be indexed
and the index categories that belong to the document class that you
selected
use the input help to select an index category, and click on the
Category function to get information about the
Index
You get to the Creating and Checking-in Metadata Documentation from the
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 16 of 22
Change Documentation
!--a11y-->
You can find additional information about each of the functions under Tab Page: Indexing for a Search.
Prerequisites
You have executed the activities described in the Business Information Warehouse Implementation Guide (IMG) under Documents for BW Objects:
Creation of an RFC Destination in the BW System
Creation of a Search Server Relation
Procedure
1. Set the Indexing Status to On.
2. If you have already edited documents without switching on the index, choose
3. If you want to generate online documentation, choose
4. Schedule the index job using
5. Choose
Job Overview Indexing and check whether the index job was successful. If you have chosen the start date value Immediately when
scheduling the index job (step 4), you still have to release the job in the job overview.
!--a11y-->
Procedure
1. You get to the Creating and Checking-in Metadata Documentation from the Repository screen. Select the object types (TLOGO) for which you want to
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 17 of 22
generate documentation.
all (*)
single values
an interval (using input help)
multiple selection (using )
2. Choose the version for which the documentation needs to be generated. You can generate documentation both for the active version as well as for the
content version.
You need the active version if you want to search in reporting or in the Administrator Workbench according to the current documentation for metadata.
You only need the content version then if you want to search in the Metadata Repository for the administrator workbench according to the
documentation in the content version. Content version generation takes some time to complete.
3. Specify whether the links for the dependent BW objects also need to be generated in the documentation. If you generate the links, the generation process
takes substantially longer, because the system creates a where-used list for all BW objects. Afterwards, you can also use the objects in the where-used
list to search for texts.
For example, if the Person Responsible characteristic is the attribute for the Cost Center characteristic, and you search in the documents
according to the Person Responsible name, then the search machine finds both characteristics (or their documentation). Without generating
links, the search machine only finds the Person Responsible characteristic (or its documentation).
The program runtime depends on the number of objects and whether you are generating links to other objects in the documentation.
The program takes a while to run, so we recommend that you
restrict the selection
schedule the program to run as a background job ( Program -> Execute in the Background ).
only generate all the documentation the first time round, afterwards, only generate the BW InfoObjects that have been changed (see Take
Changes to Metadata into Account)
4. Choose
Execute . The system generates the online documentation for the BW objects that you selected, and puts them in the index queue.
Since online documentation is always generated dynamically, this is the only way that it can be indexed, and that you are able to access the
search function. You must call up this program for all installed languages.
!--a11y-->
Structure
In the table, you can see the characteristics that are document properties, along with their generation status.
If there are still errors, click on the
Integration
In the maintenance screens for characteristics, you have to set the Characteristic is a document property indicator for all the characteristics that you want
to use as properties of documents for InfoProvider data.
When the characteristics are activated, the system generates the document properties from these characteristics, and inserts them as instance-attributes for
the document classes for InfoProvider data (BW_PH_TRAN and BW_LO_TRAN).
You can look at these attributes and document classes in the Document Modeling Workbench in the BW (Business Information Warehouse)
document area.
When it creates them, the system writes the document properties to a transport request. This is for technical reasons. You must write the document classes
to a separate transport request that you do not transport. It is enough to transport the characteristics with the Characteristic is a document property setting.
When you have transported the characteristics, you must generate the document properties in the target system.
The generation process does not run automatically in the after-import handling of the characteristics. The system tells the database that the
generation process has not started yet. The process that generates the document properties is triggered the first time you call the document
management in the target system.
See also:
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 18 of 22
!--a11y-->
Task
Comments are to be written in reports about the characteristic combination Country and Month.
The following comments are to be assigned to the characteristic value USA for the Country characteristic and the characteristic value "January" for the
Month characteristic:
Sales were bad in January in the USA because the exchange rate for the dollar was extremely low
Technical conversion
From a technical point of view, the comments are created with the document properties Country = USA and Month = January.
The characteristics Country and Month have to be activated with the indicator "Characteristic is document property". Under this condition, for each of these
characteristics, a property (attribute) is generated in the model for document management ( Document Modeling Workbench ).
Using the indicator Characteristic is document property, you can establish, both technically and semantically, for which characteristics documents for
InfoProvider data can be defined. All characteristics that are not activated as document property are not taken into account when documents are created or
selected.
As needed, you can activate more characteristics as document property.
We recommend activating as few characteristics as possible as document properties so that the display and selection of documents remains
clear.
!--a11y-->
Use
Online documentation for a BW object is constantly being updated from the metadata repository. For central objects, the where-used list or the data flow lists a
large number of objects so that online documentation is extensive. In these cases, building online documentation can take a long time. Thus on the Online
Documentation tab page you have the option of hiding the sections with links to objects that depend on online documentation.
Options on the online documentation tab page
Area of online documentation
Information
Where-used list:
Links to online documentation for those objects that the current object uses are not
generated.
See also:
!--a11y-->
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 19 of 22
Use
The specification of MIME types is for the exchange of data, especially multimedia Internet data of fundamental importance.
Structure
The following table shows the MIME types delivered regularly by SAP with the BW system.
Official MIME types are registered by the IANA (Internet Assigned Numbers Authority). Private sub-types, received after being checked by the
IANA, begin with vnd. (in the form vnd.company-type or vnd.type) or prs.
Subtypes for locally permitted file formats for the server begin with x-type.
MIME Types
Basis Type
Subtype
Description
application
Type for files that are linked to a specific
/acad
/dxf
/mif
/msexcel
MS Excel File
/mspowerpoint
/msword
Microsoft Word
program
Reference
Exchange/Reader)
/rtf
/vnd.ms-excel
Excel File
/vnd.ms-powerpoint
/vnd.ms-word
/winword
/x-javascript
JavaScript File
/x-msmetafile
WMF File
/x-sapshortcut
/x-zip-compressed
ZIP File
/x-pn-realaudio-plugin
/bmp
Icon
/gif
/ico
Icon (Windows)
/ief
RFC1314
(see
RFC2045, RFC2046
/tiff
RFC2302
/x-rgb
RGB Graphics
/x-windowdump
X-Windows Dump
audio
Type for sound files
image
Type for graphics files
Single Document).
text
/calendar
Type for text files
/css
RFC2045, RFC2046
RFC2445
CSS Style Sheet File
/enriched
RFC2318
RFC1896
/htm, /html
/javascript
JavaScript File
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
RFC2854
Page 20 of 22
video
Type for video files
/plain
Simple Text
RFC2646, RFC2046
/richtext
RFC2045, RFC2046
/xml
RFC3023
/avi
/x-msvideo
/x-sgi-movie
Integration
You can create additional, customer-specific MIME types. You can find additional information under Editing Valid File Types.
!--a11y-->
Procedure
1. You are in the Managing the BW Document Administration screen. Choose
for MIME Content Type (Customer Table) screen.
Edit Valid File Types . You arrive in the View File Name Enhancement
For example, if you want to add HTML in the table as the standard type for Web sites, enter the type of file (content type) in the form basic
type/subtype: text/html. The file name enhancement has a standard naming: .html or .htm.
The standard was established by the HTML work group for the World Wide Web Consortium (W3C) and was determined in the Request for
Comments (RFC) 2854 The 'text/html' Media Type (June 2000).
5. Save your entries. You arrive at the Workbench Request Query dialog box.
6. Choose a suitable request, and confirm the request.
Result
The MIME types that you entered in the table are also available for selection for the SAP-delivered MIME types when creating a new document for the
General tab page. You can find additional information under Creating Documents.
!--a11y-->
Note that the technology of document integration will be moved to the Java platform in the future. As in BW Release 3.0 and 3.5, the option of
modifying the standard will also be available there, but not with ABAP, with Java code instead. If you utilize BAdIs for use in documents, you
have to migrate your ABAP implementation to the Java platform.
The following tables provide an overview of the BAdIs and defined for use in documents and their methods:
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 21 of 22
BAdI
Methods
CHANGE_PROPERTIES
CREATE_PROPERTIES
DELETE_PROPERTIES
STORE_CONTENT
SELECT
HIERARCHY_RESOLVE
Description
CHANGE_RENDERING
Description
CHANGE_RENDERING_CONTEXT
CHANGE_RENDERING_FUNCTIONS
CHANGE_RENDERING_LIST
CHANGE_RENDERING
Method
Description
DETERMINE_VERSION_HANDLING
BEFORE_RENDERING
Standard Settings
The BAdIs can be used multiple times and are not dependent on filter.
See also:
You can find more information in the system documentation for interface methods.
In order to display this documentation, you first have to branch to the interface by double clicking on the interface names. On the Methods
tab page of the Class Builders , select the desired method
Documentation .
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Page 22 of 22