Tab Page: Indexing for a Search 

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:

Field

Information

Search engine status

Selection options: OK/Not Completely Installed

Index 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.

 Help

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

Index jobs

Status of the index job

Selection Options: Scheduled/Not Scheduled

Execution date

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

 Schedule Index Job

You get to the Start Date Values 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.

In the Job Name field, specify the name of the index 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 Information, you have help available.

Choose Execute.

You get to the Job Overview screen.

You can find additional information under Managing Jobs with the Job Overview.

Additional Functions

 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.

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

You get to the KPRO IMS: Monitoring screen.

Monitoring Tab Page:

Use the input help to select a document class.

Choose the Refresh function.

The system uses the traffic light colors ( and ) 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 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 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 whether or not they can 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 Index Category function to get information about the
    • available language indexes
    • attributes that can be indexed
    • document classes, and whether or not they can be indexed

 Generating Documentation for Metadata

You get to the Creating and Checking-in Metadata Documentation from the Repository screen.

  1. Select the object types (TLOGO) for which you want to generate documentation.
    • all (*)
    • single values
    • an interval (using input help)
    • multiple selection (using )
  1. 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.
  1. 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 Generate Links indicator refers to the regular generation within the scope of an index job. Consequently, only the changed objects are edited.

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)

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.

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. In the following section, changes made to the Metadata are recorded and taken into account when running the indexing job the next time. 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 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 (see Generation of Metadata Documentation).

This setting relates to the initial generation.