Index

File Search Engine

  1. Introduction
  2. Concepts
  3. Configuration
    1. Declaring the File Areas
    2. Setting the List Headers
    3. Building the Access List
    4. Building the File List
    5. Enabling the File Search Engine
    6. Letting your users know how to use the File Search Engine

Index | File Search Engine Index | Next

Introduction

The Online Assistant for TeleFinder File Search Engine is undoubtedly one of the most powerful features of the suite, since it provides a quick, easy to use search through files on your system, by name or by comment.

As well as the simple searches, OAT creates full file listings for each file area you designate, so you can then place these files online in a public area (or alias them into each directory) in order to let your users see what you have online without going to the trouble of viewing by thumbnail (slow) or getting info for each item.


Index | File Search Engine Index | Previous | Next

Concepts

The TeleFinder Access Group system allows you, the sysop, to specify which areas on your system are accessible to which users. The OAT File Search Engine is closely integrated with the Access Group mechanism to ensure that access privileges are honoured correctly. However, due to some ambiguity regarding the definitions of the Access Group paths, it is necessary to tell OAT explicitly which areas you want included in search requests.

One good reason for doing this is so that you can split many sublevel file areas into different file areas, rather than the one directory that is specified in User Manager. For example, an Access Group file area called 'Macintosh Files' may have subdirectories such as 'Communications' and 'System Extensions'. Using the OAT's private mechanism means that you can distinguish between these to areas.

In order for OAT to honour the access privileges you have defined in your Access Groups, OAT must traverse the directory tree of all the declared paths and record the privileges for each distinct directory. This must be done before any other File Search Engine task may be performed. In addition, if you modify any Access Groups, you must update OAT's Access Group list for the changes to be reflected in the File Search Engine.


Index | File Search Engine Index | Previous

Configuration

Very little configuration is required to begin using the File Search Engine. The basic steps that must be taken are detailed below:
  1. Declare the File Areas
  2. Set the List Headers
  3. Build the Access List
  4. Build the File List
  5. Enable the File Search Engine
  6. Let your users know how to use the File Search Engine

Declaring the File Areas

Before proceeding with this step, you should have a good idea in your mind of how you would like to organise the File Areas that OAT will index. One possible system would be as follows: As you may see in the example, it is possible to create hierarchially nested areas.

Once you have decided on the organisation of the File Areas (this may simply be the structure of your existing BBS File Areas), you must tell OAT about them. You do this by creating aliases using the Finder, and placing them in a special folder.

The special folder into which you place aliases to each File Area you want to define is called the 'File Area Aliases' folder, and is found inside the 'File Search Engine Data' folder in the distribution folder.

If you create a normal folder inside this folder, it is treated as a hierarchial category (the Macintosh and PC areas shown in the example above would be implemented as normal folders).

The easiest way to make the aliases is to use a system extension like 'Finder Extensions Enabler' or 'AliasDragger'. This lets you control-drag items in the Finder to make aliases in the destination. However, if you do not have this ability, you can simply make aliases in the usual manner (Make Alias from the File menu in the Finder). You do not have to remove the suffix ' alias' from the created aliases, because OAT will automatically detect and ignore it.

You can see an example of the Finder window showing the implementation of the above File Area system.

Once the File Listing process is complete, the structure you have defined in this section will be duplicated in the 'File Area Text Listings' folder, with the aliases you created being replaced by text files listing all the files and comments in that area.

Building the Access List

To build the Access List, first ensure that User Manager is running and correctly linked to OAT.

Next, select 'Update Access List Now' from the File Search Engine submenu on the Online Assistance menu in OAT as shown. A task will appear in the Task Window, and you can see the progress of the process.

Once the Access List is complete, you are ready to move onto the next step.

Setting the List Headers

If you wish, you can customise the text that appears (the footer) at the bottom of each file listing generated by OAT. To do this, place files that correspond to the file areas you have defined in the 'File Area Headers' folder, inside the 'File Search Engine Data' folder inside the OAT folder. There is a file named 'Default' that will be used if a corresponding file cannot be found.

Building the File List

Provided you have completed the previous step, you can simply select 'Update File List Now' from the File Search Engine submenu on the Online Assistance menu in Max as shown. A task will appear in the Task Window, and you can see the progress of the process.

Enabling the File Search Engine

Provided you have first built the Access Group list and then updated the File List, you can turn on the File Search Engine. This step makes the Search Engine available for your users to access. Simply ensure that the 'Enabled' item is checked in the File Search Engine submenu on the Online Assistance menu in OAT.

Information for your users

[the following information is available in the 'Online Files for your users' folder]

File Search Engine is an online utility that you can access via the "Users Online" option, found under the "Chat" menu.

File Search Engine allows you to search through the file areas on this BBS for files which contain a specific string in their file names or comments. This is much faster than the 'BBS Find File' option, and supports searching through the files' comments, all while doing other things on the BBS. In fact, you do not even need to stay logged on to the BBS while the search is executed, since the results will be placed in your private mail folder.

To access the File Search Engine, send it an instant message, as detailed below.

Searching for a File by Name

Send a message with the text "Find <text>".
Replace <text> with the text you are searching for. If this text contains any spaces, you must place it in quotes ("). This command will only search through the names, not the comments. Searching for names only is considerably faster than searching through comments.

You will be notified of the progress of the search by return instant messages (at the start and end of the search).

If you wish to see how the search is getting along, you can send the message "Status", which will return a message to you indicating the progress of the task.

If you decide you want to abort the search (perhaps to start another one), you can send the command "Abort". Any results found up to this point will be returned to you.

Searching for a File by Comment

Send a message with the text "Find <text> in comments".
Replace <text> with the text you are searching for. If this text contains any spaces, you must place it in quotes ("). This command will only search through the comments, not the names. This search will take longer than a simple name-only search.

You will be notified of the progress of the search by return instant messages (at the start and end of the search).

If you wish to see how the search is getting along, you can send the message "Status", which will return a message to you indicating the progress of the task.

If you decide you want to abort the search (perhaps to start another one), you can send the command "Abort". Any results found up to this point will be returned to you.

Searching for a File by Name and Comment

To search by name and comment, send a command of the form:
"Find <text> in name and comments"
Operation is as described in the previous two sections.
Main Index