User’s Guide

User’s Guide

Together Teamlösungen EDV-Dienstleistungen GmbH

Elmargasse 2-4
A-1190 Vienna
Austria
Phone: +43 (0) 5 04 04 - 122
Fax: +43 (0) 5 04 04 - 11 122
E-Mail: 
Web: http://www.together.at/together/index.html

All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without the prior written permission of the Together Teamlösungen EDV-Dienstleistungen GmbH.

Together Teamlösungen EDV-Dienstleistungen GmbH DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.


Table of Contents

1. About 'Together Search Server' and 'Together Document Viewer'
Fast execution
Web application
Flexible
2. 'Together Search Server' Searching
Searching
Basic Search
E-Mail Search
Search Results
XSL Transformation
Document management actions
Preview link
3. 'Together Document Viewer'
About
Presentation Object Preview
Parameters
Document management actions

List of Figures

2.1. Basic search
2.2. E-Mail Search
2.3. Search Result Page
2.4. File download dialog
3.1. Word preview
3.2. PDFpreview
3.3. File download dialog

List of Tables

2.1. Examples of search over text field
2.2. Examples of search over Date field

Chapter 1. About 'Together Search Server' and 'Together Document Viewer'

Fast execution

'Together Search Server' and 'Together Document Viewer' are a fast and lightweight indexing and searching applications designed using 'Together application server' - platform built to handle extreme high volume web sites in an n-tier architecture.

Web application

'Together Search Server' and 'Together Document Viewer' are a web applications that can run on virtually any existing web server. The whole applications runs and is managed trough a web browser which limits the system requirements (resources) need to run it on the client side. The installation and configuration on the server side as very simple as well and the whole process takes less than 5 minutes.

Flexible

'Together Search Server' and 'Together Document Viewer' are written in pure JAVA which guarantees its execution on virtually any OS currently in use. Thanks to its modular design, 'Together Search Server' and 'Together Document Viewer' can be easily extended/upgraded with new features, search and indexing engines etc.

Chapter 2. 'Together Search Server' Searching

Searching

Search part of the application consists of a search module that enables:

  • Basic search

  • E-mail search

Basic Search

Clicking the SEARCH button on the main page loads the sites basic search and displays it in the cetral part of the page:

Figure 2.1. Basic search

Basic search

Checking the checkboxes in the top of the page selects sites to be searched. Basic searsh is searh over content of the document. According to this, query examples are listed in the table.

Table 2.1. Examples of search over text field

Query expressionMatches document that
searchContain the term search
search enhydraContain the term search or enhydra, or both
search OR enhydraContain the term search or enhydra, or both
"search application" OR enhydraContain the fraze "search application" or just enhydra, or both
(search OR application) AND enhydraContain the term either search OR application AND enhydra.
"search application" NOT enhydra"search application" NOT enhydra
+search +enhydraContain search but not contain enhydra
search AND enhydraContain both search and enhydra
search*Contain terms that begin with search Note: You cannot use a * symbol as the first character of a search
search~Contain terms that are close to the word search
sna*perContain terms that begin with "sna" and ends with "per"
snapp?rContain terms that are close to the word snapp?r Note: You cannot use a ? symbol as the first character of a search.

Clicking the Search button performs the search.

'Modified(from/to)' are date fields, examples of query expresions over them are listed in the 'Examples of search over Date field' table.

Table 2.2. Examples of search over Date field

ModifiedMatches documents that
From: 20020101 To: 20030101Are between "Year : 2002 , Mounth : 01 , Date : 01" and "Year : 2003 , Mounth : 01 , Date : 01"
From: 20020101 To: =Are sent/received "Year : 2002 , Mounth : 01 , Date : 01"
From: 20020101 To:Are between "Year : 2002 , Mounth : 01 , Date : 01" and current date
From: To: 20020101Are between "Year : 1970 , Mounth : 01 , Date : 01" and "Year : 2002 , Mounth : 01 , Date : 01"


E-Mail Search

Selecting the E-Mail from File type combo-box loads the sites E-Mail search and displays it the left side of the page.

Figure 2.2. E-Mail Search

E-Mail Search

Checking the checkboxes in the top of the page selects sites to be searched.

E-Mail search enables more complex and detailed searches through E-mail metadata like: date of sent/received e-mail, from/to/cc/bcc, subject of the e-mail and finally through e-mail content.

Available fields (e-mail specific metadata) over whom search can be obtained are clasified by field type:

'Content ', 'Subject ' , 'From', 'To', 'CC' and 'BCC' are text fields, examples of query expresions over them are listed in the 'Examples of search over text field' table.

Depends which radio button is selected search can be obtained over 'Mail Sent/Received' date fields or will be ignored if selected 'Uknown', examples of query expresions over them are listed in the 'Examples of search over Date field' table. If Sent is checked, mails that were sent between entered dates will be searched. If Received is checked, mails that were received between entered dates will be searched

Search Results

Search results representation is a standardized web page output just like any other search engine (i.e. Google). The main difference between 'Together Search Server' and other search engines is that it includes XSL transformations that are defined in an .xsl file. This way a system administrator can style the search results output in accordance with system needs/wishes.

XSL Transformation

File that needs to be edited in order to change the search output webpage in runtime is WEB_INF\classes\xls\searchResults.xls, WEB_INF\classes\xls\search.xls and WEB_INF\classes\xls\advancedSearch. For example, editing the “font” parameter and changing the font size, changes the font size (and the look of the page) as soon as the next search on the search page is performed.

The standard results page:

Figure 2.3. Search Result Page

Search Result Page

Document management actions

Context menu action on document(s) in search result page will open context menu with document management action available on that document(s): Read, Download, Download (ZIP), Download (PDF) - for Office files, Copy, Copy (ZIP), Copy (PDF) - for office files, Send, Send (ZIP), Send (PDF) - for Office files, Send link, Print and Print To.

Figure 2.4. File download dialog

File download dialog

Preview link

Clicking the preview (link) in the Search Results page opens the 'Together Document Viewer'.

Chapter 3. 'Together Document Viewer'

About

'Together Document Viewer' is application for previewing files. It could be used with 'Together Search Server' or as stand alone application with parameter parseOnFly when file will be first parsed and result will be shown. When it is used with s'Together Search Server' it shows indexer content of the file. It has two presentation object, Preview.po and ShowPicture.po.

Word preview

Figure 3.1. Word preview

Word preview

  • available actions – Send document content to Google translate

PDF preview

Figure 3.2. PDFpreview

PDFpreview

  • available actions – Send document content to Google translate.

Presentation Object Preview

This po object uses request parameters to form an XML file defined by a preview.dtd. After the XML is created the po object uses an xsl file defined in xsl request parameter (default is ‘preiew.xsl’) to transform the xml file and display the results.

Parameters

  • xsl – The xsl file that will be used to transform xml file. If this parameter is not defined the default xsl will be used (preview.xsl). If xsl=none is used, output will be xml tree.

  • query - The query was used for search.

  • id – Lucene id of the document placed in the index. It must be used with parameter SiteName

  • SiteName - The name of the site.

  • fullFilePath – Valid URL of the file for preview. If parseOnFly is set to true, file will be parsed and result will be displayed. This way siteName and MetaData will not be available. Without parseOnFly parameter 'Together Search Server' engine will be searched for file with given file path and result from indexer will be shown (no parsing will be performed)

  • parseOnFly – Overrides searching 'Together Search Server' engine and forces preview on fly

  • parserPageLimit – Overrides configuration parameter 'Previewer.ParserPageLimit'.

  • parserCharacterLimit – Overrides configuration parameter 'Previewer.ParserCharacterLimit'.

Document management actions

Context menu action on document(s) in search result page will open context menu with document management action available on that document(s): Read, Download, Download (ZIP), Download (PDF) - for Office files, Copy, Copy (ZIP), Copy (PDF) - for office files, Send, Send (ZIP), Send (PDF) - for Office files, Send link, Print and Print To.

Figure 3.3. File download dialog

File download dialog