Show TOC

Background documentationUsing the Connector Administration Cockpit

 

The connector administration cockpit is the entry point for the administration of Search and Analysis. It provides an overview of the available connectors and allows the system administrator to monitor their status and schedule indexing runs. You can also access further administration and monitoring tools as well as the modeler, which you can use to define your own connector models.

 

You use the following URL to launch the administration cockpit:

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

In this case, <Host name> stands for the SAP NetWeaver host and <Port number> stands for the port that you use to reach the SAP NetWeaver system.

Alternatively, you can launch transaction ESH_COCKPIT from the SAP system.

Caution Caution

Depending on which technology is used (TREX, SAP NetWeaver BWA, or SAP HANA), certain functions, filters, and entries are hidden in the administration cockpit. If SAP HANA is used, only functions and filters for Operational Analytics are available.

End of the caution.
Structure

The administration cockpit displays all connectors filtered by status.

Filtering Connectors

You can filter the connectors listed in the connector overview by the following status values:

Value

Explanation

All

Lists all connectors irrespective of status.

Active

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

This status is set by default after completion of indexing.

Inactive

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

New

Lists all new connectors that have not been prepared.

Preparing

Lists all connectors for which the preparation is in process. During the preparation, the physical indexes and join indexes are created in the indexing layer.

Prepared

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

Scheduled for Update

Status of the connectors after you have chosen the Update function.

This status is retained until the asynchronous scheduled background job for the update starts.

Scheduled for Deletion

Status of the connectors after you have chosen the Delete function.

This status is retained until the asynchronous scheduled background job for deletion starts.

Is Being Deleted

Status of the connectors while they are being deleted.

Scheduled for Indexing

Lists all connectors for which indexing is scheduled.

Indexing

Lists all connectors for which the indexing is in process.

With Errors

Lists all connectors with errors.

Not Defined

This status appears if the system cannot determine any other status.

Connector Overview Area

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

Column

Explanation

Connector Name

Displays the name and ID of the individual connectors.

Connector ID

Shows an ID with connectivity data for the connection to the search provider, for example, the RFC destination of the back-end system containing the business objects for which the connector was defined.

Changed

Specifies that the model used to created this connector has been changed in the modeler. To update the connector accordingly, select it and choose Actions Update.

Search

Specifies whether or not the connector can be used for the search.

In this context, you should note the relationships to the status of the connector:

  • Status Inactive or Prepared: Not searchable

  • Status With Errors after delta indexing: Already indexed objects are still searchable

Analysis

Specifies whether or not the connector can be used for analysis.

Status

The current status of the connector.

Index ID (only for Embedded Search)

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

Table Name (only for Operational Analytics in SAP HANA)

Name of the table in SAP HANA.

Last Indexing (only for Embedded Search)

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

Last Update (only for Operational Analytics in SAP HANA)

Date and time of last update.

Optimized (only for Embedded Search)

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

Number of Entries (only for Operational Analytics in SAP HANA)

Number of business objects that were processed.

With Errors (only for Embedded Search)

Number of search objects for which indexing was not completed because an error occurred.

In Process (only for Embedded Search)

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

Connector Details Area

When you select a connector in the connector overview, the details of this connector appear here. This includes the scheduling data for the indexing runs, for example.

Tab Page

Description

General

Display detailed information about the connector or its nodes.

Scheduling

Display the time of the first scheduled indexing. If you have set up recurring indexing, the interval is also shown here.

You can choose Delete Schedule to delete all scheduled indexing runs.

Job Log

You can see here the log information for the job that is assigned for the selected object.

In the dropdown list, you can call up the logs for the available technical objects.

The log information corresponds to the information that you can also call up for a specific job from the job overview in the Related Links section.

Categories

In addition to the categories specified in a model, you can create and manage other categories here.

Note Note

Note that categories created here are not maintained in the model.

End of the note.

You cannot delete categories that originate from the model here.

More information: Managing Search Categories

Control Bar

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

Note Note

You can choose more than one connector and thus perform an action on more than one connector at the same time. To do this, hold down the Ctrl key and select the required entries.

Actions are displayed as inactive if an action cannot be executed for the connector. In the case of multiple selection, all selected entries must support the chosen action. If an action is not possible for any one of the connectors, it appears as inactive. In such cases, correct your selection.

End of the note.

Pushbutton/Command

Function

Status Selection

Filters by the required status.

Update

Refreshes the list of connectors and their respective status.

Create

This takes you to a dialog box, with which you can create connectors from predefined models.

You choose the required model from the required software component and choose Create Connector, then the system creates a new connector in the background.

You should note that further connectors are implicitly created if fields in the response or requests of the connector being created are referenced by other connectors.

Delete

Deletes the selected connector. A message informs you whether the deletion process takes place in the background or not.

Actions

Lists the actions that are available for the selected connector.

You can find a list of the actions in the table below.

Searching

In the overview, you can search for connectors or indexes by entering the name or part of the name in the search field and pressing Enter or choosing the Search button to start the search. A match appears as the first entry in the overview.

Repeat the search to find more matches in the overview.

System Settings

This pushbutton takes you to the following system settings:

Edit System Uses

Here, you can define the software components for creating connectors. You can use the Suggest implicit settings (number) function to add or edit implicit changes, or reset to the last saved database status.

Manage UI Technologies

For more information, see Maintaining UI Technologies.

Control Indexing in Real Time

For more information, see Controlling Real-Time Indexing.

Display/Edit Model

Takes you to the modeler, in which you can display or edit the selected connector.

Modeling

The link takes you to the modeler, in which you can define your own connector models. More information: Using the Search and Analytics Modeler

The following commands are available through the Actions pushbutton:

Action

Description

Activate

Activates the selected connector.

Deactivate

Deactivates the selected connector.

Update

Updates the selected connector so that it reflects the changes made to the underlying model. If an underlying model has been changed, the checkbox in the Changed column is activated for the connector in question. The update is processed in the background.

Reset

Resets the selected connector to its newly-created status. The preparation is triggered automatically.

Prepare Indexing

Starts the preparation of the connectors for which automatic preparation ended with errors.

Scheduling Indexing

Schedules indexing for the selected connectors.

Continue Indexing

Continues the indexing run at the point at which it was stopped due to an error.

You can identify indexing runs with errors by filtering by connectors with the status With Errors. You can then trigger indexing for these runs again.

Consistency Check

You can use the consistency check to solve errors in connectors.

Select the connectors that have an error status and start the consistency check. The system performs a sequence of tests to establish the cause of the error.

You receive the check results with details of the individual tests. Read the error messages to receive more detailed information about the cause of the error.

Example Example

If no search request is defined for a connector, the system cannot perform a search and the consistency check reports an error. Define a search request to solve the error.

End of the example.
Related Links

Using the links in the Related Links section, you can access the following monitoring and administration tools:

Link

Explanation

Application Log

This link takes you to the application logs written during the preparation and indexing of a connector. 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.

For more information, see Displaying a Job Log.

TREX Administration (only for Embedded Search)

This link takes you to the TREX administration tool, which you can use to monitor and manage the available indexes.

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

More Information