Start of Content Area

Object documentation Tab Page: Indexing Documents  Locate the document in its SAP Library structure

Definition

On the Indexing Documents 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.

Caution

Note that these functions are obsolete. We recommend that you use metadata search/indexing. See: BI Metadata Search and Tab Page: Indexing Metadata.

 

Use

You have to fill the following prerequisites before you can search in the documents belonging to BI objects:

...

       1.      Indexing 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 Indexing Documents tab page contains the following fields and functions:

Status display

Field

What You Need to Know

Status of search engine

Display options: OK/Not Completely Installed/Simulation (Test)

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 Documents tab page (in the performance assistant).

Index jobs

Field

What You Need to Know

Status of the indexing job

Display options: scheduled/not scheduled

This graphic is explained in the accompanying text Schedule Index Job

The Start Time dialog box appears. Specify that you want the indexing program 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, at the same time as loading jobs in BI).

This graphic is explained in the accompanying text Indexing Job Overview

The Simple Job Selection screen appears. 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 Job Status. Under This graphic is explained in the accompanying text Information, help is available.

Choose This graphic is explained in the accompanying text  Execute. The Job Overview screen appears. For more information, see Managing Jobs with the Job Overview.

Additional functions

Field

What You Need to Know

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

The Re-Index a Class or a Document Area screen appears.

You can re-index all of the documents in a document class, 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 upgrading the BI system to release 3.0, because before this release, the search function was not available for documents for metadata.

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

The KPRO IMS: Monitoring screen appears.

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 whether they can be indexed

¡        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 whether they can be indexed

 

 

End of Content Area