Background documentationUsing the Administration Cockpit Locate this document in the navigation structure

 

The Enterprise Search Administration Cockpit represents the central starting point for the configuration and administration of Enterprise Search. It provides an overview of the configured search object connectors and allows the system administrator to monitor their status and to manage crawls for files searches and Web searches. In addition, it provides access to the configuration tools for Enterprise Search: The template modeler, the connection wizard, and the configuration editor.

Use the following URL to access the Administration Cockpit:

http://<host_name>:<port_number>/sap/es/cockpit

In this case, <host_name> stands for Enterprise Search and <port_number> stands for the port through which Enterprise Search can be reached.

Structure

The Administration Cockpit displays all search object connectors, filtered by either status or connector type.

This graphic is explained in the accompanying text.

Administration Cockpit Structure

Filter Panel

In the filter panel, you can filter the search object connectors listed in the connector overview by status or by search object connector type. You can use the following status values to filter the list:

Value

Explanation

All

Lists all search object connectors irrespective of status or type.

Active

Lists all search object connectors that are active, that is, that can be used for searching.

This status is set after completion of the preparation, extraction, and indexing for search object connectors of the types BO Search and File Search.

Inactive

You define a search object connector as inactive to exclude it from the search function. This status applies for all search object connector types.

New

Lists all new search object connectors that have not been prepared and for which extraction and indexing has not yet been started.

Changed

Applies for the following search object connector types: BO Search, BO Search Service, MDM, and BI

Lists all search object connectors for which the template has been changed.

In Preparation

Applies only for the search object connector type BO Search.

Lists all BO search object connectors for which the preparation is in process. During the preparation, the system generates PI process chains for the individual nodes and creates the physical indexes and join indexes in the indexing layer.

You can scheduled indexing for these search object connectors. However, indexing only starts once the preparation has finished. Instead, the system sets a flag that specifies that indexing is required. The indexing is scheduled automatically once the preparation has finished.

Prepared

Applies only for the search object connector type BO Search.

Lists all BO search object connectors for which the preparation has finished. The indexing can now be scheduled or started immediately for these search object connectors.

Scheduled for Indexing

Applies only for search object connectors of type BO Search.

Lists all search object connectors for which indexing is scheduled.

Extraction

Applies only for search object connectors of type File Search and BO Search.

Lists all search object connectors for which the extraction of the search data from a file share, Web server system, or back-end system is in process.

Indexing

Applies only for search object connectors of type File Search and BO Search.

Lists all search object connectors for which indexing is in process.

With Errors

Lists all search object connectors with errors. The system automatically defines these as inactive.

Alternatively, you can filter search object connectors listed in the connector overview by the search object connector type.

Note Note

You cannot combine the filters, this means that you cannot display all object connectors of type BO Search Service that are defined as inactive.

End of the note.
Connector Overview Area

The connector overview contains the following information for the individual search object connectors:

Column

Explanation

Search Object Connector

Displays the name and ID of the individual search object connectors.

Search Provider

Displays the connection data for the connection to the search provider, for example the URL at which a repository can be found or the RFC destination of the back-end system containing the business objects for which the search object connector has been defined.

Changed

Specifies that the search object connector template used to created this search object connector has been changed in the template modeler. To update the search object connector accordingly, select it and choose Update (see below).

Status

The current status of the search object connector, index, or crawl.

Index ID

Applies only for search object connectors of type File Search and BO Search.

The index ID in the indexing layer (TREX) of Enterprise Search.

Last Indexing

Applies only for search object connectors of type File Search and BO Search.

Date and time of the last indexing (initial indexing and index update).

Optimized

Applies only for search object connectors of type File Search and BO Search.

Number of files or business objects that have been processed and indexed.

With Errors

Applies only for search object connectors of type File Search and BO Search.

Number of search objects for which indexing was not completed.

In Process

Applies only for search object connectors of type File Search and BO Search.

Number of search objects in the queue that are still to be processed.

Connector Details Area

When you select a search object connector in the connector overview, the details of this connector appear here. These details include the crawl settings for object connectors for SAP File Search or scheduling information for indexing for object connectors for SAP BO Search.

Control Bar

This section contains the pushbuttons for performing actions for the search object connector that is selected in the connector overview.

Note Note

Some of the pushbuttons and menu items are only active if a search object connector, an index, or a crawl is selected.

End of the note.

Pushbutton/Command

Function

Refresh

Refreshes the list of search object connectors and their respective status.

De(activate)

This toggle button activates or deactivate the search object connector selected in the connector overview.

  Create   Search Object Connector  

You access the connection wizard, which you can use to create search object connectors from predefined templates or from which you can go to the configuration editor if no template is available (for KM Search connectors and Web service connectors).

  Create   Search Object Connector Template  

Takes you to the template modeler, where you can define your own search object connector templates.

  Edit   Search Object Connector  

Takes you to the configuration editor, where you can edit the existing search object connector templates.

  Edit   Search Object Connector Template  

Takes you to the template modeler, where you can edit the existing search object connector templates.

Delete

Deletes the selected search object connector.

Update

Updates the selected search object connector so that it reflects the changes made to the underlying connector template. If an underlying search object connector template has been changed, the checkbox in the Changed column is activated for the search object connector in question.

Prepare

Starts the preparations for search object connectors of type BO Search for which automatic preparation ended with errors.

Index

Applies only for search object connectors of type SAP BO Search.

Starts indexing for object connectors of type SAP BO Search that are selected in the Search Object Connectors (connector overview) area.

Reset

Resets an object connector of type SAP BO Search to status Created. The preparation is triggered automatically.

  Manage Crawl   <Command>  

Applies only for object connectors of type SAP File Search.

For more information about each command, see Managing Crawls.

  Operate Crawl   <command>  

Applies only for object connectors of type SAP File Search.

For more information about each command, see Managing Crawls.

Navigation Panel

Using the links in the You can also go to... section, you can access the following monitoring and administration tools:

Link

Explanation

Application log

This link takes you to the application logs (ABAP) written during the preparation and indexing of a connector of type SAP File Search. These logs are important during troubleshooting.

Job Overview

This link takes you to an overview of the jobs scheduled for preparation and indexing in the ABAP system. Here you can monitor the processing of these asynchronous jobs for a connector of type SAP File Search.

TREX Administration

This link takes you to the TREX administration tool, which you can use to monitor and manage the indexes created for Enterprise Search. On the screen displayed, choose Execute to launch the TREX administration tool for the corresponding TREX system.

For more information, see TREX Admin Tool in the SAP System.

Extraction Monitor

Applies only for the BO Search. This link takes you to the extraction monitor, where you can monitor the process chains that were created during the extraction of business objects from the back-end system.

Basic Configuration Test

Starts a test of the basic configuration of your Enterprise Search installation.

More Information: Basic Configuration Test

SAP Management Console

Launches the SAP Management Console, which you can use to monitor all systems and hosts for Enterprise Search (AS ABAP, AS JAVA, TREX, Web Dispatcher) with a central tool.

If necessary, you can restart systems through the SAP Management Console or call up log files and traces.

For more information about SAP Management Console, see the SAP NetWeaver documentation.

More Information