Show TOC

Procedure documentationCreating and Activating Search Object Connectors Locate this document in the navigation structure

 

SAP ships templates for the search function of the Help Center in the HELP_CENTER software component. The search templates contain predefined objects with settings for retrieving and displaying information. You can use the search templates to create and activate the search object connectors required to search for Help Center content.

Prerequisites

You have access to the administration cockpit of the Embedded Search solution.

More information: Creating Search Object Connectors and Starting Indexing (from the Embedded Search configuration guide)

Procedure

1. Create Search Connectors
  1. In the SAP system, call the administration cockpit of the Embedded Search. You can use a URL (link to corresponding documentation in the Prerequisites section) or call transaction ESH_COCKPIT.

  2. In the administration cockpit, choose   Create  .

  3. Select the software component HELP_CENTER.

    The system lists the templates for search object connectors under Connector Templates.

    Template for Search Object Connector

    Use for Search in Help Center

    HC_NOTE

    Search for personal notes

    HC_FAQ

    Search for frequently asked questions

    HC_LINK_FILE

    Search for files that the Help Center links to that are saved in a shared network folder

    HC_LINK_URL

    Search for Web pages that the Help Center links to (the search is based on the link texts and Web addresses of the pages, not their content)

    HC_LIBRARY

    Search for help topics in the installed SAP Library

    HC_GLOSSARY

    Search for entries in the SAP glossary of the installed SAP Library

  4. Select the templates and choose   Create Connector  .

  5. Check the status of the new search object connectors in the list of search object connectors.

    Note Note

    The new search object connectors are not ready for indexing until they have the status Prepared.

    .
    End of the note.
2. Perform Indexing for Search Object Connectors
  1. In the administration cockpit, select the search object connectors of the Help Center.

  2. Choose   Actions   Schedule Indexing  .

  3. For the selected object types, activate the options Start Immediately (default setting) and Indexing in Real Time.

    Recommendation Recommendation

    Indexing for the object types HC_LIBRARY and HC_GLOSSARY takes a considerable amount of time; we therefore recommend that you schedule indexing accordingly. Note that the indexing will take longer if several language versions of SAP Library and glossary are installed.

    End of the recommendation.

    Note Note

    Before the SAP Library and glossary are indexed for the first time, the system performs an analysis of the data as Indexing Preparation. The indexing is based on the result of the indexing preparation. If you have updated SAP Library, you must reset the indexing preparation in the Help Center Implementation Guide before indexing again.

    More information: Defining Use of the Application Help in the Help Center

    End of the note.

      Files of type PDF, PPT, DOC, HTML, TXT, and so on are indexed. The maximum file size is set to 10 MB.

    • Check whether indexing is finished.

      The following indicators tell you whether indexing of a search object connector is finished:

      • The status is Active.

      • The Searchable indicator is set.

      Note Note

      In the event of an error, you can display the job log in the detailed data of the search object connector.

      End of the note.
    3. Define Connection Parameters for Links in the Results List

    To enable the system to construct the addresses of the objects in the search results list, you have to specify the connection parameters of the system for each UI technology used. The connection parameters apply for all connectors of the system.

    1. In the administration cockpit, choose   System Settings   Maintain UI Technologies  .

    2. For the Web Dynpro (Application Server) entry, set the Active indicator.

    3. In the SAP NetWeaver Application Server: Details section, enter the connection parameters Protocol, Host, and Port.