How to Administer TREX

How to Administer TREX for SAP GTS

Ap pl ies to : SAP BusinessObjects Global Trade Services 8.0 For more information, visit the Governance, Risk, and Compliance homepage

Summary Search and Classification TREX provides SAP applications with numerous numerous services for searching, searching, classification, and text-mining in large collections of documents (unstructured data) as well as for searching in and aggregating across business objects (structured data). This document shows how to administer TREX. Au thor th or::

Prarit Sehgal

Company:

Regional Implementation group Governance, Governance, Risk, and Compliance SAP BusinessObjects Division

Created Created o n:

16 September 2009

Version 1

SAP COMMUNITY NETWORK © 2009 SAP AG

SDN - sdn.sap.com | BPX - bpx.sap.com | BOC - boc.sap.com

How to administer TREX for SAP GTS

How to administer TREX for

SAP GTS

Typographic Conventions

Icons

Type Style

Descript ion

Icon

Example Text

Words or characters quoted from the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options.

Description Caution Note or Important Example Recommendation or Tip

Cross-references to other documentation Example text

Emphasized words or phrases in body text, graphic titles, and table titles

Exampl e t ext

File and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools.

Example text

User entry texts. These are words or characters that you enter in the system exactly as they appear in the documentation.

Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system.

text>

EXAMPLE PL E TEXT

Keys on the keyboard, for example, F2 or ENTER.





SAP GTS

Table of Contents 1.

Business Scenario............................................................................................................... 1

2.

Background Information ..................................................................................................... 1

3.

Prerequisites ........................................................................................................................ 2

4.

Step-by-Step Procedure ...................................................................................................... 3 4.1

Starting the TREX admin tool ....................................................................................... 3

4.2

Connecting TREX with an Application.......................................................................... 3 4.2.1

4.3

4.4 5.

Connecting TREX with an ABAP Application (RFC Connection) .................... 4

TREX Administration .................................................................................................. 11 4.3.1

Starting and Stopping TREX.......................................................................... 11

4.3.2

TREX Admin Tool .......................................................................................... 11

4.3.3

Data backup and Restore for TREX .............................................................. 16

Connecting TREX with a Java Application (HTTP Connection) ................................. 17

FAQ ..................................................................................................................................... 18 5.1

Stopping TREX with the TREX Admin Tool ............................................................... 18

5.2

Selecting Languages for TREX Language Recognition ............................................. 19

6.

Comments and Feedback ................................................................................................. 21

7.

Copyright ............................................................................................................................ 22





SAP GTS

1.

Business Scenario

Search and Classification TREX provides SAP applications with numerous services for searching, classification, and text-mining in large collections of documents (unstructured data) as well as for searching in and aggregating across business objects (structured data). TREX processes documents in a wide variety of formats and languages. TREX administration is organized into the following areas: ●

Starting and Stopping TREX To start and stop TREX, you use the SAP Management Console and the executable files startsap.exe and stopsap.exe (Windows) or the Shell scripts startsap and stopsap (UNIX).

●

TREX Admin Tools TREX provides the following administration tools: ○

TREX Monitor in the portal You use this tool if you are implementing the Knowledge Management functions in the portal.

○

TREX Admin Tool in the SAP System You use this tool if TREX is connected to an SAP system.

○

TREX Admin Tool (Stand-Alone) You can use this tool independent of a portal or an SAP system.

●

Data Backup and Restore for TREX You can make a backup of a TREX installation, and restore the TREX installation using the backup version if problems occur.

●

Administration of the Search Engine Service The Search Engine Service (SES) enables users to search for business objects using TREX. As an administrator, you complete the initial configuration of the search engine service and monitor it during routine operation.

2. Background Information TREX is based on client/server architecture. The client component is integrated into the application that uses the TREX functions, and allows communication with the TREX servers. The server component processes the requests; it indexes and classifies documents and answers search queries. The client component is subdivided into the Java client and ABAP client. The server component is subdivided into the following servers: ●

Web server with TREX extension

●

RFC server

●

Queue server

●

Preprocessor

●

Index server

●

Name server



SAP GTS

3. Prerequisites The TREX in installed, the user has access to TREX admin tool. You must create an SAP user that the TREX admin tool (stand-alone) can use to log on to the SAP system. In addition, the SAP user is required so that the TREX alert server has permission to regularly test and check the RFC configuration. The TREX admin tool (stand-alone) is used to configure and monitor TREX. You also use this admin tool to configure the RFC connection between TREX and the ABAP application that is using TREX. To use the TREX admin tool (stand-alone) to create the RFC destination, the admin tool requires an SAP system user that you create based on the predefined role SAP_BC_TREX_ADMIN. This user then has the authorization required to configure the RFC connection.



SAP GTS

4. Step-by-Step Procedure 4.1 Starting the TREX admin tool Log on with the user adm, and carry out one of the following steps Operating system: UNIX Procedure: Enter the following: cd ./TREXAdmin.sh Operating system: Windows Procedure: Start the TREX admin tool by double-clicking \TREXAdmin.bat in Windows Explorer

4.2 Connecting TREX with an Application TREX can communicate with the application using it by means of an HTTP connection or an RFC connection: An ABAP application accesses TREX by means of an ABAP client (RFC connection) As a rule, ABAP applications communicate with the TREX servers by means of the TREX ABAP client using the RFC/SNC protocol. Communication takes place using an instance of the SAP Gateway and an RFC server. ●

A Java application accesses TREX by means of a Java client (HTTP connection) As a rule, Java applications communicate with the TREX servers by means of the TREX Java client using the HTTP or HTTPS protocol. This communication takes place using a Web server that is enhanced with TREXspecific functions. ●



SAP GTS

4.2.1

Connecting TREX with an ABAP Application (RFC

Connection) As a rule, ABAP applications communicate with the TREX servers by means of the TREX ABAP client using the RFC/SNC protocol. Communication takes place using an instance of the SAP Gateway and an RFC server. You configure the RFC connection using the TREX admin tool (stand-alone). Creating a SAP System User for the TREX Admin Tool Procedure Create an SAP system user for the TREX admin tool (stand-alone) and assign the SAP_BC_TREX_ADMIN role to this user. 1. Launch transaction SU01 (user maintenance) or choose Administration → System Administration → User Maintenance → User in the SAP menu. The User Maintenance: Initial Screen appears. 2. Enter a new user name and choose Create. 3. On the Address tab page, enter the personal data for the user. 4. On the Roles tab page, assign the SAP_BC_TREX_ADMIN role and thus the permission to access the SAP system to the SAP system user for the TREX admin tool (stand-alone).

Determining the SAP System Connection Information The TREX admin tool (stand-alone) can connect to an SAP system in two ways. ●

Through a specific application server of the SAP system (variant A)

Through the message server of the SAP system (variant B) This variant uses the load-balancing function for the SAP system. The message server assigns the request from the TREX admin tool to any application server. ●

Depending on the variant used, the TREX admin tool requires different connection information for the SAP system. You must determine the connection information and specify it later in the TREX admin tool. NOTE: SAP recommends using variant B. Variant A has the disadvantage that the connection does not work if the application server is not available.

Procedure 1. Open the SAP Logon. SAP Logon is the program that you use to log on to an SAP system.



SAP GTS

2. Note the following connection information: ...

Connecti on Setup Type

Required Connectio n Inform ation

Through an application server (variant A) ●

SAP system ID (SID)

●

System number

●

Application server host name

●

SAP system ID (SID)

●

Logon group, such as PUBLIC

●

Message server host name

Through the message server (variant B)

Configuring the RFC Connection in the TREX Admin Tool You work through the steps below using the TREX admin tool

Creating a Connection 1. On the RFC: Current tab page in the Landscape: Connectivity window, choose the Create Connection function.

2. Choose connection type A or B. Specify the connection data for the SAP system.



SAP GTS

3. Specify the SAP system user, the associated password, and the client that the TREX admin tool is to use to log on



SAP GTS

If the SAP system user in question exists in the default client, you do not need to specify the client. Now click on “RFC Destination” Add details, “SAP System”, “RFC Destination, and click “save”

How to administer TREX for SAP GTS SAP GTS

Check the “Configuration Status”, it should be green




SAP GTS

After performing the above steps RFC connection is created in SM59. Go to transaction SM59

Click drop down “TCP/IP connection” Double click the RFC connection created “TREX_11”

Click “Connection Test”

How to administer TREX for SAP GTS SAP GTS

You should get a similar screen as below




SAP GTS

4.3 TREX Administration 4.3.1

Starting and Stopping TREX

You use the following executable files and scripts to start and stop TREX on windows and UNIX: Windows ●

TREX admin tool (standalone)

●

The startsap.exe and stopsap.exe executable files

●

SAP Management Console As of TREX 7.10, the SAP Management Console is a snap-in in the Microsoft Management Console (MMC) and is no longer part of the TREX installation. To start TREX with the SAP Management Console, you must install the console in your TREX system first.

UNIX ●

TREX admin tool (standalone)

●

The startsap and stopsap shell scripts

4.3.2

TREX Admin Tool

You can use this tool independently of a portal or an SAP system. The TREX admin tool provides all functions for configuring and monitoring TREX. You can use this tool to configure a distributed TREX system, to configure the RFC connections, to administrate delta indexes, and to trigger performance traces. In addition, this tool provides detailed technical information about the components of a TREX system. Using periodically executed checks, it can monitor the system status automatically. In the event of errors, you are informed by e-mail so that you can take appropriate action

4.3.2.1 TREX Monitoring The TREX Monitor offers the following functions: Function

Short Descripti on

Server Status

Displays the status of the TREX server. You can see which hosts TREX servers are installed on, and whether the servers are available. The server st atus is displayed first when you navigate to the TREX Monitor .

Display Queues

Displays the status of queues. See Monitoring Queues.



SAP GTS

Display Queue Entries

Displays information on the processing of documents in a queue. See: Information on Processing Documents

Edit Queue Parameters

For displaying and Changing Queue Parameters See: Queue Parameters

Delete Queue Entries

For deleting a document from the queue if errors occur. See: Deleting Documents from a Queue

Change Queue Status

For stopping queues and reactivating them, and triggering the complete processing of a queue. See: Suspending a Queue Activating a Queue Triggering the Processing of a Queue

Reset Failed Document Entries

For resetting the error status of documents. This affects documents that have not been preprocessed, indexed, or optimized. See: Resetting the Error Status

Display Index Details

For displaying Index Parameters See: Displaying Index Parameters

Search and Classification Cache

For emptying the search and classification cache. See: Emptying the Search and Classification Cache

4.3.2.2 TREX Admin tool in SAP System In SAP systems, you can call a tool for administrating TREX by calling transaction TREXADMIN. You can use this tool to administrate the queues, monitor TREX, and display information about the components in a TREX system.

In the Connection to RFC Server field, use the RFC destination to choose which TREX system you want to administrate. Once you have selected the RFC destination, the administration areas become active.



SAP GTS

RFC Monitor tab lets you do a connection test as shown below

The following administration areas are available in the TREX admin tool in the SAP system (transaction TREXADMIN): Tab

Description

Queue Administration This tab page is only relevant if indexing takes place using the queue server. Queue Administration

You can monitor queues, configure queue parameters, and troubleshoot here. More information: Queue Administration Tab Page.

Queue Landscape

This tab page is relevant only for distributed TREX systems and only if indexing is done using a queue server.



SAP GTS

Here you can see the distribution of the queues among the different queue servers. More information: Queue Landscape Tab Page . Index Administration This tab page displays technical information on indexes. Index Admin

For example, here you can see the time of the last indexing, the number of searchable documents, or the disk space taken up by the index. This tab page displays the hierarchical structure of an index.

Index Hierarchy

It shoes the index type of an index. In the case of a split index, you can see which index parts it consists of. More information: Index Types.

Join Index Info

This tab page displays technical information about compound indexes and BIA indexes. This tab page is only relevant for distributed TREX systems.

Index Landscape

Here you can see the distribution of the indexes among the different index servers. In addition, you can check the index replication status. For more information, see Index Distribution and Index Replication Status.

Usage

This area displays information about index use and statistics.

Search

You can trigger searches from the Search tab page. You use this function for test purposes only.

Attribute Mining

You can use this TREX function to display the statistical distribution of attributes in an index.

Cruiser Administration You use this tab page to administrate and configure the TREX cruiser components. The TREX cruiser enables a file search on file servers and Web servers. TREX then indexes the files that are extracted from the searched file and Web servers. Cruiser

More information: Cruiser Administration. Note For more information on using and optimizing the TREX cruiser, see



SAP GTS

SAP Note 1110112 – TREX 7.0/7.1: How to use the TREX Cruiser.

Landscape Administration

Summary

Alert

This tab page provides an overview of the TREX status with information on the TREX version, operating system, and current error messages. This tab page is used to monitor TREX. Checks are performed periodically and in the event of errors, you can be notified by e-mail. For more information, see TREX Alert Server .

Reorg

This tab page enables the reorganization of the indexes in a TREX landscape. More information: Reorganization of the TREX Landscape. This tab page displays technical information on a TREX system.

Topology For more information, see Topology Information. Displays the TREX configuration files. You can display the content of the configuration files and change it if necessary.

Ini Files

Caution Changing configuration files directly requires expert knowledge of the TREX architecture and TREX-internal processes. Only make direct changes to the configuration files if those changes are described in the TREX documentation.

Hosts

This tab page displays information on the installation directory, operating system platform, and installed TREX release. More information: Information on TREX Servers (TREXADMIN)

Services

Displays the load on the TREX servers in a table. There is a separate row for each TREX server. More information: Information on TREX Servers (TREXADMIN)

Threads

On the Threads tab page, you can see which threads are currently executing which methods. You can also see how long processing of a method has taken so far. More information: Information on TREX Servers (TREXADMIN)



SAP GTS

Handles

On the Handles tab page, you can see the number of handles that a process has generated and is using. More information: Information on TREX Servers (TREXADMIN) Displays the trace files of the TREX servers.

Trace

By default, the trace files contain all error messages that the TREX servers output. You can display the contents of a trace file by double-clicking it. You can download the trace files. This tab page displays the configuration of a distributed TREX system. You can only display data here. You configure a distributed TREX system using the TREX admin tool (standalone).

Landscape For more information about setting up and configuring a distributed TREX system, see Distributed TREX Systems (Multiple Host Installation) and Setting Up a Distributed System. This tab page shows whether or not all of the SAP system application servers have a connection to the TREX system. If there are errors here, they can have the following causes: •

•

•

RFC Monitoring

The application server is communicating through an SAP gateway that has not been started. The parameters of the RFC destination do not match the TREX configuration. No TREX RFC server has registered with the SAP gateway. Note The window shows only whether the connection from within the SAP system works. It does not display whether the connection works from within the TREX system. The TREX admin tool (standalone) displays the complete status of the RFC connection and allows you to configure the RFC connection and correct the error. For more information on the RFC connection between TREX and the application using TREX, see Configuring and Administrating the RFC Connection.

4.3.3

Data backup and Restore for TREX

You can back up Search and Classification (TREX), and restore the TREX installation using the backup version if problems occur (backup and restore). You can back up and restore TREX in the following ways:



SAP GTS

•

Data Backup (Online) and Restore You back up TREX indexes and queues online using Python scripts without stopping TREX and while the TREX search continues to be available. You then restore the saved data offline. This is the usual way to back up TREX data. It is a good idea to back up the TREX indexes if the original index creation process took a long time and you want to avoid having to reindex if the full-text information is lost. SAP also recommends that you back up your data if a large number of documents have been added to an index since the original indexing process.

•

Complete Data Backup and Restore (Offline) You back up a complete TREX installation (TREX indexes and configuration) offline and restore it again. You do this only in special circumstances, particularly to back up the settings in a TREX configuration. In this case, the complete data backup and restore of the TREX installation can take the place of a new installation.

4.4 Connecting TREX with a Java Application (HTTP Connection) As a rule, Java applications communicate with the TREX servers by means of the TREX Java client using the HTTP or HTTPS protocol. This communication takes place using a Web server that is enhanced with TREX-specific functions. The TREX Java client needs to know the address of the TREX name server in order to communicate with the TREX servers. You specify the address of the TREX name server, and, in the case of a distributed TREX installation, of the TREX backup name server, in the SAP NetWeaver Administrator.

Procedure You have to specify the address of the TREX name server in the SAP NetWeaver Administrator by naming the following values :: ●

●

: name of the host on which TREX is installed and where the TREX name server runs. : port of the TREX name server 1. You can determine the TREX name server address in two ways: a. Start the TREX admin tool. Determine the address of the name server using Landscape → Tree → topology → globals → all_masters.



SAP GTS

b. Determine the port of the TREX name server by means of the following rule: : 301 On UNIX, navigate to following location or path shown below.

2. Use the user to log onto the host on which the Application Server Java is running.

3. Start the SAP NetWeaver Administrator and log on to the AS Java . 4. Navigate to Configuration Management Properties.

→

Infrastructure Management

→

Java System

5. In the new screen go to the tabulator Services in the screen area Details and type in trex.service to filter the available services. 6. In the Extended Details area under the tabulator Properties enter the address of the TREX name server into the parameter nameserver.address: tcpip://: You enter only the host name or the host name and the domain depending on your network environment. tcpip://mytrexhost:34801 or tcpip://mytrexhost.mydomain:34801



SAP GTS

The address of the TREX name server must be configured for all server processes of the cluster. Otherwise the connection between the AS Java and TREX cannot be established. 7. In case of a multiple host scenario for a distributed TREX landscape you enter the addresses of the TREX backup name servers in the parameter nameserver.backuplist. Specify the address of the TREX backup name servers, separated by comma in the format: tcpip://:,tcpip://:, … For a TREX single-host installation you do not need to specify backup name servers. 8. Save your changes and confirm the restart of the service.

5. FAQ 5.1 Stopping TREX with the TREX Admin Tool 1. Log on with the user adm. 2. Start the TREX admin tool by double-clicking \TREXAdmin.bat in Windows Explorer. 3. In the TREX admin tool, navigate to the Landscape Services area and then go to the MMC tab.



SAP GTS

4. You can stop TREX by clicking the SAP System: Stop button or by selecting the TREX host, opening its context menu with the secondary mouse button, and selecting the relevant option. You can stop Selected Hosts or All Hosts for a landscape.

5.2 Selecting Languages for TREX Language Recognition TREX supports the indexing and analysis of documents in different languages. You can select languages to be identified by TREX language recognition. The language of a document is needed so that the document in question can be placed in the correct language version of the index. For each language that you select, TREX creates a seperate language index For example, if you select English, German, and French, TREX English, one German, and one French language index. Procedure 1. Start the TREX admin tool 2. In the preprocessor: Admin window, navigate to the Languages tab page. The Languages for Document Analysis area contains an overview of language TREX supports. In this area, select the languages that you want TREX to identify by means of document analysis.



SAP GTS

6.

Comments and Feedback

Your feedback is very valuable and will enable us to improve our documents. Please take a few moments to complete our feedback form. Any information you submit will be kept confidential. You can access the feedback form at: http://www.surveymonkey.com/s.aspx?sm=stdoYUlaABrbKUBpE95Y9g_3d_3d



SAP GTS

7. Copyright © 2009 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, System i, S ystem i5, System p, System p5, System x, S ystem z, System z9, z/OS, AFP, Intelligent Miner, WebSphere, Netfinity, Tivoli, Informix, i5/OS, POWER, POWER5, POWER5+, OpenPower and PowerPC are trademarks or registered trademarks of IBM Corporation. Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated 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 GTS

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and s ervices 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. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SA P Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. These materials are provided “as is” 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 not be liable for damages of any kind including without limitation direct, special, indirect, or consequential damages that may result from the use of these materials. SAP does not warrant the accuracy or completeness of the information, text, graphics, links or other items contained within these materials. 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. Any software coding and/or code lines/strings (“Code”) included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or grossly negligent.



SAP GTS

https://www.sdn.sap.com/irj/bpx/grc

How to Administer TREX

Recommend Documents