Documente Academic
Documente Profesional
Documente Cultură
3
Overview..................................................................................................................... 3
Filtering....................................................................................................................... 3
Indexing rules.............................................................................................................. 3
Scalability ................................................................................................................... 4
Searching..................................................................................................................... 4
The query language..................................................................................................... 4
How to Install.................................................................................................................. 5
Sunbelt Search installed through a separate setup ...................................................... 5
Sunbelt Search installed by the Installation package.................................................. 6
Enable Sunbelt Search .............................................................................................. 11
Configure Sunbelt Search ............................................................................................. 15
How to conduct a fulltext search .................................................................................. 16
Sunbelt Exchange Archiver Outlook AddIn fulltext search ..................................... 16
ArchiveWeb fulltext search ...................................................................................... 20
Appendix....................................................................................................................... 24
Sunbelt Search basic syntax references .................................................................... 24
Overview
Sunbelt Search ensures fast and effective searching through documents of various
formats. This is achieved by indexing the content of documents. By indexing the content
we understand “extraction” of words contained in the document, their positions and
number of occurrences. The engine allows searching for exact words, for words
containing specified groups of characters (defined by wildcards), and for phrases (groups
of words).
Every indexed document has its owner. Document owners are identified by a unique
number called a user token. This user token system allows defining rights ensuring that
users can search not only through their own set of documents but also through other
users’ documents.
Filtering
During filtering, which is the first step of document processing, we extract text from the
document. Filtering supports a wide variety of document formats.
To index different types of documents you must have correct iFilters installed. Without
an appropriate IFilter, the file contents will not be indexed, and when you search for
those contents, you won't find them. The iFilters for Office documents and plain text files
are included in the operating system. However, you can download and install additional
iFilters e.g. for PDF or RTF documents.
Indexing rules
Words are stored in relation with their parent documents; this means that every word
occurs in the index only once. Information about word’s position and occurrence count in
the relevant document is expressed by mentioned relation.
Searching
Searches within a document are based on a queries describing the searching criteria. A
query can consist of exact words, search patterns (wildcards) and phrases. A search query
also contains information about the user executing it and the target set of documents to be
searched through. For example, the user can search only for their own documents or for
all documents which he/she can access.
The syntax is checked first, before execution of the respective query. If checking fails,
such a query cannot be executed and an error is reported to the user, describing the
mistake. If checking passes through, the respective query is executed. For every indexed
word there is a rank of occurrences in a document. The more times the specified word
occurs in the document, the higher is the document rank in search results.
Characters
Character Description Example
OR Links two terms and finds a matching "test data" OR test
document if either of the terms exist
in a document. This is equivalent to a searches for documents
union using sets. The symbol || can be that contain either "test
used in place of the word OR. data" or just "test"
AND It is the default conjunction operator. "test data" AND "test
This means that if there is no Boolean server"
operator between two terms, the
AND operator is used. The AND searches for documents
operator matches documents where that contain "test data" and
both terms exist anywhere in the text "test server"
of a single document. This is
equivalent to an intersection using
sets. The symbol && can be used in
How to Install
Sunbelt Search service is an optional component of various Sunbelt products, including
Exchange Archiver and File Archiver. If installed, it allows user to fulltext search
through archived emails and documents.
In this manual, we will lead you through both types of installation – separate setup
installation and then Install package installation.
In the next window, you can check the location where the Sunbelt Search will be
installed. The default destination location is C:\Program Files\ Sunbelt\ FullText. You
can use the Change button to change the destination directory, if you wish, then click
Next.
Now you can select the fulltext engine which you want to install. To install Sunbelt
Search, choose Sunbelt Search (the 3rd option) and click Next. By selecting other options
you can install other search engines:
Exalead support – choose this option if you want to use the Exalead search
MS Search support – this option is to be selected when you want to use MS Search as a
search engine
Sunbelt Search index will be stored in the index root folder. The default location of the
index root folder is C:\Program Files \Sunbelt \FullText \Index. Should you wish to
change it, use the Browse button.
NOTE: Make sure that the chosen location has enough space for the index folder (10% - 20%
size of the whole archive).
When Sunbelt Search is installed, you can set the user under which the search service will
be running: if you click No – local system account will be used; if you click YES – you
can choose a domain user.
NOTE: The installation procedure is described step-by-step in the Install Package Guides for
respective Sunbelt products. This manual deals only with the installation and deploying of the
Sunbelt Search feature (i.e. Advanced installation – only Sunbelt Search feature selected).
Run the Sunbelt Exchange Archiver self-extracting installation package on the machine
where you want to install Sunbelt Search. Make sure you are logged on with a local
admin account. As default the package unzips to C:\Sunbelt \Sunbelt Exchange
Archiver package but you can use the Browse button to change the directory. Click
Unzip.
If you select Express installation, the whole Sunbelt product will be installed on the
machine (including the Sunbelt Search). For detailed information on how to install the
product, see the “Full Install Guide.”
IMPORTANT: To use the Sunbelt Search Service, you need to upload and enable the appropriate
post-processing plugin. It is done after installation in the Sunbelt Manager console. The plugin
can be found in C:\Program Files \ Common Files \ Pam \ Services \
PamPostProcessing \ Plugins (see the section “Enable fulltext search”).
Advanced installation – allows you to select which components you want to install. To
install Sunbelt Search feature only, choose this option.
We have selected Advanced installation in the previous dialog. In the next dialog you can
choose the installation folder. As the default the product installs in C:\Program
Files\Sunbelt. The installation folder can be changed by using the Browse button.
Further select the components you want to install on the local machine. To install Sunbelt
Search, check the respective check box.
Click the View EULA links to read the License Agreement. If you agree, check the I
accept the terms of license agreement check box. Then you can click Next.
In the Superuser settings window you need to specify an account with a mailbox under
which Sunbelt Exchange Archiver will be running. This user is referred to as superuser.
You can create a new account or use an existing one. Enter it as ‘domain\user’ or use the
Browse button to find the account. In the Search Active Directory pop-up window click
Find to display available users or enter its name in the Look for name text box. Select the
super-user account from the list. Back in the installation dialog fill in its password and
click Next.
If you have chosen to install the Sunbelt Search (see step 4), the Fulltext search settings
dialog will be displayed. Choose Sunbelt Search. In the Index folder text box, specify the
folder where the search index will be stored. It has to be a location with plenty of free
space as the size of the index is about 10% - 20% size of the whole archive. The default
index location is under C:\Program Files\Sunbelt\Fulltext. To change it, use the Browse
button.
The installation summary displays settings you have specified in previous steps. It is
useful to print the summary. Click Install button to start the installation. Wait while the
components are being installed. When the installation finishes, click Finish.
IMPORTANT: To use the Sunbelt Search, you need to upload and enable the appropriate post-
processing plugin. This process is described in the “Enable Sunbelt Search” section.
NOTE: In Sunbelt versions lower than 4.0 a Legacy Fulltext search engine was used. Since
version 4.0, a new fulltext search engine is installed – Sunbelt Search.
Administrators can decide to install new Sunbelt Search as a fulltext search engine or
continue using Legacy fulltext. Independently of the administrator’s intention the
updating process differs for dedicated fulltext server and fulltext server installed with all
other components on one machine (all in one installation).
In this case that legacy fulltext is installed on a separate machine, the administrator has
two options:
1. Continue using Legacy fulltext – in this case, an update is not needed, you can just
continue to use legacy fulltext.
However, on the archiver server, if you start the mailbox permission synchronization
after this change, the fulltext permissions will not be set. You have to create a new
registry key to support the old legacy search option: USELEGACYFULLTEXT
(REG_DWORD) and you need to set it to value 1. This will cause the synchronization to
synchronize also fulltext permissions when the permission synchronization is performed.
The manager service must be restarted after this change.
If you have decided to continue using Legacy fulltext, you have to install and reconfigure
it again using the Fulltext setup v3.80.1 (it is the last fulltext setup where Legacy Fulltext
was supported)
NOTE: As a next step, Sunbelt Exchange Archiver must be configured to use the Legacy fulltext.
In the Sunbelt Exchange Archiver Enterprise Manager on the Tools/ Options /
Search settings tab, select the check the Legacy fulltext option and enter the name of your
Fulltext server.
If you start the mailbox permission synchronization after this change, the fulltext
permissions will not be set. You have to create a new registry key:
If you want to use new Sunbelt Search, install it as described in the previous section.
IMPORTANT NOTE: All archived emails and documents will have to be reindexed. To do so,
configure the post-processing plugin and the plugin’s bookmark date has to be reset, so that older
documents are reindexed (see the next section “Enable Sunbelt Search”).
Further, in the Sunbelt Exchange Archiver Enterprise Manager on the Tools/ Options /
Search settings make sure that the Sunbelt Search server option is selected.
In the following lines we will guide you through the process of plugin configuration for
Sunbelt Exchange Archiver.
Run the Sunbelt Exchange Archiver Enterprise Manager on the Sunbelt server (click
Start\ Programs\ Sunbelt \ Sunbelt Exchange Archiver \ Enterprise Manager or run it
from C:\Program Files\ Sunbelt \ Sunbelt Exchange Archiver \ Applications\
EnterpriseManager\ PamEnterpriseMan.exe). This will open the Sunbelt Exchange
Archiver Enterprise Manager window. On the View menu, select Manager view.
In the Manager view, click on the Post Processing tab. Click on the Add button.
NOTE: You may also click with your right mouse button inside the left pane and in the context
menu select New Plugin.
Installed plugins will be loaded in the Add Plugin pop-up window. Select the
PostProcessSunbeltSearchIndex.SearchIndexPlugin in the down-drop box and click
Add.
The plugin becomes listed on the Post Processing tab in Sunbelt Exchange Archiver
Enterprise Manager. By default it is active.
NOTE: If no mailboxes are selected then post processing will not process any archived emails
and attachments.
On the Post Processing tab, select the desired plugin. Right-click it and in its context
menu click Edit Plugin.
In the Plugin properties window you may choose for which mailboxes you want to
apply the plugin, i.e. which mailboxes will be indexed for fulltext searching. Check:
Apply for all mailboxes or Apply for selected mailboxes and click the Mailboxes
button
NOTE: Make sure that the Plugin is active is checked so that the plugin is enabled.
In the Select mailbox or group enter the name of a mailbox in the text box or double-
click the desired mailbox in the list. In the Selected objects dialog you can check which
users you have selected. Confirm by clicking OK.
In case you want to apply Sunbelt Search plugin also for emails having been archived
before this plugin was enabled, you need to set it in a bookmark date. Bookmark date
serves as a pointer to the last processed document. Post processing processes only
documents which are newer than the bookmark date. If you want to reindex older
documents, you have to reset the bookmark. Reindexing is necessary e.g. when upgrading
from old Legacy fulltext to our new Sunbelt Search.
Right-click the desired plugin and click Set Bookmark from the context menu.
In the Enter bookmark window specify the desired time. Click OK.
NOTE: You may notice that the bookmark date becomes displayed on the Post Processing
tab in the right pane.
NOTE: If you reset the bookmark date, the change takes effect immediately, there is no need to
disable and enable the plugin.
NOTE: If you remove a plugin by using the Remove button, it will stop completely and all
information about processed documents will be lost. However, the index remains. If you then
load that plugin again, you need to configure it. It will process all documents again, but the index
will not change.
C:\Program Files\Sunbelt\SEA\Web\ExchangePamWS\web.config
2. Check the lucenefturi key. It contains the remoting address for the Sunbelt Search
service. Example:
<add key="lucenefturi" value="tcp://PMAC-EX2007:8228/PamSearch" />
3. Test the searching functionality by archiving some sample emails, logging in to
the ArchiveWeb and making a test search query.
ArchiveWeb is an integral part of all Sunbelt products. It is used for browsing archived
emails and/or files. On the contrary, Sunbelt Exchange Archiver Outlook Addin is
applicable just for Sunbelt Exchange Archiver.
Fulltext search can be used not only for searching through in archived emails and
attachments but even for searching in emails which were archived but are not accessible
in Outlook any more. The service is accessible either from the Sunbelt Exchange
Archiver menu or from Sunbelt Toolbar. (See the screenshots below.)
You can enter the desired word or expression in the provided text box. Click Search. The
entered keyword is subsequently looked for in the:
subject;
The result of the search is then displayed in the Search results pane, where you can
retrieve emails simply by selecting an email and clicking on the Display button or by
double-clicking the desired email.
The entered words can be combined using logical operators AND, OR. The operator
AND is not mandatory. In the case no logical operator is included, the fulltext search
query engine searches for documents containing all the given words.
The searched word (or string) can be also specified by a pattern. The pattern contains the
character string to search for and can contain a wildcard: ?, * (see Appendix).
Example: When searching for the phrase “text search” you won’t get as a result a mail
containing the phrase “fulltext search”.
There is a counter for each word, which counts the number of occurrences of each
respective word having been searched for. The number of occurrences is included under
the Rank column. The outcome of the fulltext search is listed descending, depending on
the number listed under the Rank column.
The Search text box in the upper part of the window was designed for fast and easy
searching in archives. Enter the desired expression and click on the search icon adjacent
to the Search text box. The defined expression will be searched for in Sunbelt Exchange
Archiver archive as well as Sunbelt File Archiver archive.
NOTE: Email attachments, email bodies and file contents are searched through only if Sunbelt
Search is installed (as described in the previous sections).
To start searching with advanced search options, just click on the Search tab in the
navigation pane. The Search menu contains the following nodes:
Common search – allows you to search in all archived emails and files (accessible only
when both products – Sunbelt Exchange Archiver and Sunbelt File Archiver – are
installed in the environment)
Sunbelt Exchange Archiver – allows you to search in archived emails (accessible if
Sunbelt Exchange Archiver is installed in the environment)
Sunbelt File Archiver – allows you to search in archived files (accessible if Sunbelt File
Archiver is installed in the environment)
Search templates – contains saved search templates and search results
In the next sections we deal with different search types (Common search, Sunbelt
Exchange Archiver and Sunbelt File Archiver search) one by one.
Common search
To search in both Sunbelt File Archiver as well as Sunbelt Exchange Archiver archives,
you can use the common search option. After clicking the Common search node, you
can enter your search criteria in the main pane.
IMPORTANT NOTE: The Fulltext search is an advanced search feature. In addition to basic
search (searching in subject, recipient, file name, folder etc.), fulltext searches for the given
expression also in the email body, attachments and file content.
Fulltext is active for the Sunbelt Exchange Archiver or Sunbelt File Archiver archive
only when:
Sunbelt Search feature was installed during the product installation respective post
processing plugin was configured in the Sunbelt Exchange Archiver/Sunbelt File
Archiver Manager
To start fulltext searching, enter the desired word, phrase, or combination of words with
logical operators (AND, OR) or word with patterns into the Fulltext text box.
NOTE: For more information on search patterns and queries which can be used in the Fulltext
text box, click the Information icon ( ) next to the text box.
Further, you can specify your search criteria in more details by using the Name/subject
and Folder text boxes. In that case files/emails with the given name/subject or residing in
the specified folder will be searched for. In the Size text boxes the minimal and maximal
size limits can be entered. Do not forget to select the correct size units (B, KB, MB, GB).
Use the Created on text boxes to look for mails received or files archived during a
specific time period (date format is YYYY/Month/DD).
In the Tagged with section, you can set search criteria regarding the tags. By checking
the respective check box, select which tag category should be searched through. Further,
if you click Mark with all tags radio button, the search result will contain only emails and
documents which are tagged with ALL selected tags. If you click Mark with any texts
Finally click Search. For Common search the result list is limited to 5 items. Click Show
All to see all results. Search results can be saved, exported, tagged etc. – see the
“ArchiveWeb manual”.
NOTE: For more information on search patterns and queries which can be used in the Fulltext
text box click the Information icon ( ) next to the text box. Please note that the fulltext search is
enabled only if Sunbelt Search was installed and the post processing plugin was configured in
the Sunbelt Exchange Archiver Manager as described in the previous sections.
You can also specify your search criteria in more details by using the Subject and From
text boxes. In that case emails with the given subject and/or sender (From text box) will
be searched for. You do not need to enter the whole name in the From text box. If you
click the Resolve button, all senders‘ names containing the specified string will be
displayed and you can choose which sender(s) you want to search for.
The Sent To text box,.(the possibility to search for emails sent to given recipients) is
available if the “Recipients” post processing plugin is installed (see the “ArchiveWeb
manual”). In the Sent To text box, enter the desired recipient (more recipients have to be
separated by semicolon “;”). You do not need to enter the whole name. If you click the
Resolve button, all recipients names containing the string specified in the Sent To text
box will be displayed and you can choose which recipient(s) you want to search for.
In the Recipient type down-drop box you can further specify your criteria, i.e. specify
whether the desired recipient(s) appeared on the To, Cc or Bcc line, on any of them or
only on the To line as the only person when the email was sent. In the Tagged with
section you can specify which category of tagged emails should be searched through.
If you are given access rights to other mailboxes, you may want the search to be
conducted in these mailboxes, too. If that is the case, select the desired mailboxes on the
Mailboxes tab or check Select all check box to search in all accessible mailboxes.
NOTE: Partially accessible mailboxes have little red lock attached to the icon.
If Search in version is checked, each email version satisfying search criteria will be listed
separately in search results list
If Search in deleted documents is checked, ITEMS MARKED FOR DELETION IN THE
ARCHIVE WILL BE SEARCHED, too
NOTE: Should you check also the only in deleted documents check box, only items marked for
deletion will be searched.
NOTE: Email is marked for deletion in the archive, if it was, for instance, deleted from Outlook
using the Sunbelt Exchange Archiver AddIn functionality. In Search Results it is highlighted in
red. Such an item cannot be restored using the Sunbelt Exchange Archiver Enterprise Manager.
However, when such items are found, they can be exported to predefined mailbox or PST file (see
the “ArchiveWeb manual”).
If you select Compare search result with mailbox content, items in the search results
which have no shortcuts on MS Exchange (so called lost items) will be highlighted in
blue.
On the Advanced tab you may restrict your search by setting some other criteria in the
Field, Operation, and Value: fields, e.g.
Then click Add. Your specification will be displayed in the list view. In the same way
add as many criteria as you need. You can remove the specific or all criteria from the list
by clicking Delete or Delete all buttons. Search results can be saved, exported, tagged etc.
using the Actions menu – see the “ArchiveWeb manual”.
Terms
A search query can consist of terms and operators. There are two types of terms:
A Single Term is a single word such as "test" or "hello".
A phrase is a group of words surrounded by double quotes such as "hello dolly" (the
word order specified by the query is relevant).
Multiple terms can be combined together with Boolean operators to form a more complex
query (see below).
Wildcard Searches
Sunbelt Search supports single and multiple character wildcard searches.
Characters
Character Description Example
? single character wildcard; replaces any te?t matches text, test
single character etc.
* multiple character wildcard; replaces 0 or test* matches test,
more characters tests, tester etc.
NOTE: The first 2 characters of the search phrase cannot contain any of the above mentioned
wildcard specification characters, i.e. ? or *.
Boolean operators
Boolean operators allow terms to be combined through logic operators. Sunbelt Search
supports AND, "+", OR, NOT and "-" as Boolean operators.
NOTE: Boolean operators must be ALL CAPS.
Characters
Character Description Example
OR links two terms and finds a matching "test data" OR test
document if either of the terms exist in a
document. This is equivalent to a union searches for
using sets. The symbol || can be used in documents that
place of the word OR. contain either "test
searches for
documents that
contain "test data" but
not "test server"
Grouping
Sunbelt Search supports using parentheses to group clauses to form sub queries. This can
be very useful if you want to control the boolean logic for a query. To search for either
"test" or "server" and "data" use the query:
To escape these character and suppress their special meaning use the "\" (backslash)
before the character. For example to search for "(1+1):2" use the query:
\(1\+1\)\:2