Configuring the Knowledge Management Search UI

Larry Brambrut
Senior Consultant, NetWeaver RIG, SAP Labs, LLC

Introduction Search Examples Search UI Configuration Search iView Configuration More Search Features Summary
Knowledge Management is a component of the SAP NetWeaver Portal

Introduction Search Examples Search UI Configuration Search iView Configuration More Search Features Summary

Motivation for Search Components

Customer Requests
Better configuration Extensibilty Modularity Integration of customer development

SAP AG 2005, Title of Presentation / Speaker Name / 4

Assumptions
1. Search and Classification (TREX) installed 2. Indexes created for applicable content (repositories)

SAP AG 2005, Title of Presentation / Speaker Name / 5

Introduction Search Examples Search UI Configuration Search iView Configuration More Search Features Summary

Portal Toolbar Search

Search from the portal toolbar opens a new window in the portal and displays the search results.

SAP AG 2005, Title of Presentation / Speaker Name / 7

Portal Toolbar Search

If the Advanced Search is selected, the search options are displayed.

SAP AG 2005, Title of Presentation / Speaker Name / 8

Delivered Search iView

The Search iView delivered with knowledge management uses the Default Search Dialog Box configuration (more on this later).

SAP AG 2005, Title of Presentation / Speaker Name / 9

Advanced Search iView

Delivered advanced search options contains selections for indexes, properties, and folder search

SAP AG 2005, Title of Presentation / Speaker Name / 10

Custom Search iView

Create your own search component with the Search API

SAP AG 2005, Title of Presentation / Speaker Name / 11

Search from KM Navigation iViews

Search from Here automatically selects folder in search options. Search All searches for documents in all folders

SAP AG 2005, Title of Presentation / Speaker Name / 12

Introduction Search Examples Search UI Configuration Search iView Configuration More Search Features Summary

Configuration of Search Dialog Box

Default Search Dialog consists of
A Search Component Set A Search Options Set

Default setting applies to

Quick Search Search from Here * Search All * Search iViews (adapted from Master iView) *

* unless customizing

SAP AG 2005, Title of Presentation / Speaker Name / 14

Concept for Search Components

The Search iView is defined on a modular level that is based on different Search Components
There are different components available that can be used to display different types of search functions and options The components can be assigned in a certain display area (e.g. below search options, below search result ..) The customer can develop their own components The components are combined within a Search Component Set

SAP AG 2005, Title of Presentation / Speaker Name / 15

Search Component Sets

Examples for Search Component Sets:

SAP AG 2005, Title of Presentation / Speaker Name / 16

Search Components Overview

standard_search standard_search_input standard_search_options related terms search_input_indexes Search_touched_documents

SAP AG 2005, Title of Presentation / Speaker Name / 17

Available Components 1
standard_search_input

related terms

search_input_indexes

SAP AG 2005, Title of Presentation / Speaker Name / 18

Available Components 2
search_touched_documents

standard_search_options

SAP AG 2005, Title of Presentation / Speaker Name / 19

Available Components 3
standard_search includes

standard_search_input

standard_search_options

SAP AG 2005, Title of Presentation / Speaker Name / 20

Search Options Set

Examples provided in Appendix

SAP AG 2005, Title of Presentation / Speaker Name / 21

Configuration Options of Search

Default Search Dialog:
Change the Default Search Dialog Box (see former slides)
Create your own Search Component Set or configure the search options etc

The reference to the Search Result Layout Set is defined in the search.oth file
The search.oth file is stored under etc/oth

SAP AG 2005, Title of Presentation / Speaker Name / 22

Configuration Options of Search

Search commands in KM Navigation iView

Default Search Dialog

Search iView

SAP AG 2005, Title of Presentation / Speaker Name / 23

Introduction Search Examples Search UI Configuration Search iView Configuration Advanced Use of Search Summary

Search iView Template

SAP AG 2005, Title of Presentation / Speaker Name / 25

Configuration Options of Search iView

Search iView:
Create your own Search iView using the KM Search iView template The following iView parameters are definable:
Configuration of Search Components Configuration of Search Screen Layout Set for Search Results Search Component Set Search Options Set Layout Set

Search Parameters (Provided in Appendix)

SAP AG 2005, Title of Presentation / Speaker Name / 26

Configuration Options of Search iView

Search iView:
Configuration of Search Components Search Component Set

SAP AG 2005, Title of Presentation / Speaker Name / 27

Configuration Options of Search iView

Search iView:
Configuration of Search Screen Search Options Set

SAP AG 2005, Title of Presentation / Speaker Name / 28

Configuration Options of Search iView

Search iView:
Layout Set for Search Results Layout Set

SAP AG 2005, Title of Presentation / Speaker Name / 29

Search Parameters
Example of a search parameter is the &QueryString=

When the iView is launched, it is populated with the query string

SAP AG 2005, Title of Presentation / Speaker Name / 30

Introduction Search Examples Search UI Configuration Search iView Configuration More Search Features Summary

Configuration Options of Search Commands

Search Commands in KM Navigation iView:
Copy the existing commands and change the following parameter (optionally):
SearchCompsName= UISearchComponent SearchPluginName= UISearch ResourceListType (OTH)= com.sapportals.wcm.SearchResultlist/search.oth rndLayoutSet= SearchResultLayoutSet

SAP AG 2005, Title of Presentation / Speaker Name / 32

Thumbnails in Search Result

The Search Result Renderer supports thumbnails if it is defined in the Displayed Properties parameter:

SAP AG 2005, Title of Presentation / Speaker Name / 33

Item Selection (Folder Search)

Definition of items to index is now available in three flavors
Documents (all objects that are not folders) All Folders (only folders)

SAP AG 2005, Title of Presentation / Speaker Name / 34

Item Selection (Folder Search)

Preselection Items Selection

SAP AG 2005, Title of Presentation / Speaker Name / 35

Item Selection (Folder Search)

Items Selection Filter after Search

SAP AG 2005, Title of Presentation / Speaker Name / 36

Advanced Quick Search - Usage

It is possible to offer an advance search link beside the quick search

-> start search in the advance view of the Search UI

SAP AG 2005, Title of Presentation / Speaker Name / 37

Advanced Quick Search - Activation

Activate the Advanced Search via
Default Framework Page Edit the properties of the Tool Area -> Enable KM Search Advanced

SAP AG 2005, Title of Presentation / Speaker Name / 38

Introduction Search Examples Search UI Configuration Search iView Configuration More Search Features Summary

Summary

Search UI by Role Selectable Search Components Selectable Search Options Configurable Search Commands Configurable Search iViews

SAP AG 2005, Title of Presentation / Speaker Name / 40

Questions?

Q&A
SAP AG 2005, Title of Presentation / Speaker Name / 41

Appendix

Configuration of Search Options Set 1

UI Search (Default)

SAP AG 2005, Title of Presentation / Speaker Name / 43

Configuration of Search Options Set 2

UI Search (Default)

SAP AG 2005, Title of Presentation / Speaker Name / 44

Configuration of Search Options Set 3

UI Search (Default)

SAP AG 2005, Title of Presentation / Speaker Name / 45

Configuration of Search Options Set 4

UI Search (Default)

SAP AG 2005, Title of Presentation / Speaker Name / 46

Search Parameters
For advanced search StartPage=SearchPage&ConfigFileName=Navigation.xml&layoutSet Mode=exclusive&ResourceListType=com.sapportals.wcm.SearchRe sultList&SearchType=quick&Advanced=true&SearchPluginName=M yCommonUISearch&SearchCompsName=MyCommonUISearchCom ponents&rndLayoutSet=MyCommonSearchResultLayoutSet&Query String= For Basic search StartPage=SearchPage&ConfigFileName=Navigation.xml&layoutSet Mode=exclusive&ResourceListType=com.sapportals.wcm.SearchRe sultList&SearchType=quick&SearchPluginName=MyCommonUISear ch&SearchCompsName=MyCommonUISearchComponents&rndLay outSet=MyCommonSearchResultLayoutSet&QueryString=

SAP AG 2005, Title of Presentation / Speaker Name / 47

Copyright 2005 SAP AG. All Rights Reserved

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iSeries, pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner, WebSphere, Netfinity, Tivoli, and Informix are trademarks or registered trademarks of IBM Corporation in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

The information in this document is proprietary to SAP. No part of this document may be reproduced, copied, or transmitted in any form or for any purpose without the express prior written permission of SAP AG. This document is a preliminary version and not subject to your license agreement or any other agreement with SAP. This document contains only intended strategies, developments, and functionalities of the SAP product and is not intended to be binding upon SAP to any particular course of business, product strategy, and/or development. Please note that this document is subject to change and may be changed by SAP at any time without notice. SAP assumes no responsibility for errors or omissions in this document. SAP does not warrant the accuracy or completeness of the information, text, graphics, links, or other items contained within this material. This document is provided without a warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability, fitness for a particular purpose, or non-infringement. SAP shall have no liability for damages of any kind including without limitation direct, special, indirect, or consequential damages that may result from the use of these materials. This limitation shall not apply in cases of intent or gross negligence. The statutory liability for personal injury and defective products is not affected. SAP has no control over the information that you may access through the use of hot links contained in these materials and does not endorse your use of third-party Web pages nor provide any warranty whatsoever relating to third-party Web pages.

SAP AG 2005, Title of Presentation / Speaker Name / 48