Start of Content Area

Object documentation Tab Page: Indexing for a Search Locate the document in its SAP Library structure

Definition

On the Indexing for a Search tab page, there are various functions that you use in document management to enable you to check and change the status of the index and the index job.

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

Status of search engine

Selection options: OK/Not Completely Installed

Indexing status

Selection options: On/Off

If the index is ‘off’, change the setting in the Index Status dropdown box to ‘on’.

This ensures that new, deleted, and modified documents are included in the index queue.

This graphic is explained in the accompanying text Help

Displays a help text for the Indexing for a Search tab page (in the performance assistant).

Index jobs

Field

Information

Status of the indexing job

Display options: scheduled/not scheduled

Execution date

Date and time that the index job is scheduled to run.

This graphic is explained in the accompanying text Schedule Index Job

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.

Recommendation

We recommend that you schedule the job to run daily (for example, along with loading jobs for BW).

This graphic is explained in the accompanying text Index Job Overview

You get to the Simple Job Selection screen. The job name field contains the name of the indexing job.

Note

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 This graphic is explained in the accompanying text Information, you have help available.

Choose This graphic is explained in the accompanying text Execute. You get to the Job Overview screen. You can find additional information under Structure linkManaging Jobs with the Job Overview.

Additional Functions

Field

Information

This graphic is explained in the accompanying text Re-Index All Documents

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.

Example

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.

This graphic is explained in the accompanying text Monitoring the Indexed Documents

You get to the KPRO IMS: Monitoring screen.

Monitoring Tab Page:

Use input help to select a document class.

Choose the This graphic is explained in the accompanying text Refresh function.

The system uses the traffic light colors (This graphic is explained in the accompanying text and This graphic is explained in the accompanying text) to show you whether or 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 Index- Category 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 This graphic is explained in the accompanying text Trigger Process function to either start the index queue immediately or schedule it to run in the background. You get a report on the De/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 This graphic is explained in the accompanying text Test Search function to find documents

·        use the This graphic is explained in the accompanying text Problem Cases function to display documents with which there are problems

·        use the This graphic is explained in the accompanying text Indexed Documents function to find out which documents have been indexed already

·        use the This graphic is explained in the accompanying text 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 This graphic is explained in the accompanying text 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 This graphic is explained in the accompanying text Index Category function to get information about the

¡        available language indexes

¡        attributes that can be indexed

¡        Document classes and they ability to be indexed

This graphic is explained in the accompanying text Generation of Metadata Documentation

You get to the Creating and Checking-in Metadata Documentation from the Repository screen. You can find additional information under Generate Documentation for Metadata Initially.

Take Changes to Metadata into Account

Selection options: On/Off

After generating the documentation for the first time, the Take Changes to Metadata into Account indicator is active.  The system records changes made to the metadata and takes these changes into account when running the indexing job again. In the following, you do not need to execute the Generation of Metadata Documentation any longer.

If you change the setting in the selection list to “off”, you need to change the documentation for each of the following. Do this using This graphic is explained in the accompanying text Change Documentation Generation for Metadata.  

Include Links in the Documentation

Selection options: Yes/No

The inclusion of links to other objects in the documentation also enables searching using objects in the where-used list. However, this lengthens the time needed to generate documentation. The setting made for This graphic is explained in the accompanying text Generating Documentation for Metadata is used as the standard.

Note

The Include Links in the Documentation setting relates to regular link generation within the indexing job. Consequently, only the changed objects are edited.

 

 

End of Content Area