How To Administer Trex
How To Administer Trex
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
Created
Created o n: 16 September 2009
Version 1
EXAMPLE
PL E TEXT Keys on the keyboard, for
example, F2 or ENTER.
© 2009 SAP AG
How to administer TREX for SAP GTS How to administer TREX for
SAP GTS
Table of Contents
1. Business Scenario............................................................................................................... 1
3. Prerequisites ........................................................................................................................ 2
5. FAQ ..................................................................................................................................... 18
5.1 Stopping TREX with the TREX Admin Tool ............................................................... 18
5.2 Selecting Languages for TREX Language Recognition ............................................. 19
7. Copyright ............................................................................................................................ 22
© 2009 SAP AG
How to administer TREX for SAP GTS How to administer TREX for
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.
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:
● RFC server
● Queue server
● Preprocessor
● Index server
● Name server
How to administer TREX for SAP GTS How to administer TREX for
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.
How to administer TREX for SAP GTS How to administer TREX for
SAP GTS
4. Step-by-Step Procedure
cd <TREX_DIR>
./TREXAdmin.sh
● 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 TREX-
specific functions.
How to administer TREX for SAP GTS How to administer TREX for
SAP GTS
Procedure
Create an SAP system user for the TREX admin tool (stand-alone) and assign the
SAP_BC_TREX_ADMIN role to this user.
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).
The TREX admin tool (stand-alone) can connect to an SAP system in two ways.
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
...
● System number
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.
How to administer TREX for SAP GTS How to administer TREX for
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
How to administer TREX for SAP GTS How to administer TREX for
SAP GTS
If the SAP system user in question exists in the default client, you do not need to specify the client.
After performing the above steps RFC connection is created in SM59. Go to transaction SM59
Windows
● TREX admin tool (standalone)
UNIX
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.
How to administer TREX for SAP GTS How to administer TREX for
SAP GTS
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
You can monitor queues, configure queue parameters, and
Administration
troubleshoot here.
Queue This tab page is relevant only for distributed TREX systems and
Landscape only if indexing is done using a queue server.
How to administer TREX for SAP GTS How to administer TREX for
SAP GTS
Here you can see the distribution of the queues among the different
queue servers.
Index
Administration
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.
It shoes the index type of an index. In the case of a split index, you
Index Hierarchy
can see which index parts it consists of.
Here you can see the distribution of the indexes among the different
Index index servers. In addition, you can check the index replication
Landscape status.
Usage This area displays information about index use and statistics.
You can trigger searches from the Search tab page. You use this
Search
function for test purposes only.
You can use this TREX function to display the statistical distribution
Attribute Mining
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
How to administer TREX for SAP GTS How to administer TREX for
SAP GTS
SAP Note 1110112 – TREX 7.0/7.1: How to use the TREX Cruiser.
Landscape
Administration
You can display the content of the configuration files and change it
if necessary.
Caution
Ini Files
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.
On the Threads tab page, you can see which threads are currently
executing which methods. You can also see how long processing of
Threads a method has taken so far.
On the Handles tab page, you can see the number of handles that a
process has generated and is using.
Handles
More information: Information on TREX Servers (TREXADMIN)
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 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:
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.
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.
Procedure
You have to specify the address of the TREX name server in the SAP NetWeaver Administrator by
naming the following values <host_name_of_trex_host>:<name_server_port>:
● <host_name_of_trex_host>: name of the host on which TREX is installed and where the TREX
name server runs.
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.
How to administer TREX for SAP GTS How to administer TREX for
SAP GTS
b. Determine the port of the TREX name server by means of the following rule:
<name_server_port>: 3<instance_number>01
2. Use the user <j2eeadm> to log onto the host on which the Application Server Java is running.
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://<host_name_of_trex_host>:<name_server_port>
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
How to administer TREX for SAP GTS How to administer TREX for
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://<host1>:<port1>,tcpip://<host1>:<port1>, …
For a TREX single-host installation you do not need to specify backup name servers.
5. FAQ
3. In the TREX admin tool, navigate to the Landscape Services area and then go to the MMC tab.
How to administer TREX for SAP GTS How to administer TREX for
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.
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.
How to administer TREX for SAP GTS How to administer TREX for
SAP GTS
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
How to administer TREX for SAP GTS How to administer TREX for
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.
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.
JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by
Netscape.
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.
How to administer TREX for SAP GTS How to administer TREX for
SAP GTS
https://www.sdn.sap.com/irj/bpx/grc