Resource Adaptable Network Document EXchange

for Windows 95

 

INDEX

About RandeX

Setting up RandeX

RandeX.INI Variables

RandeX GUI Application

RandeX Server Application

RandeX Database Administration

About Document Organization

The Index Boxes

Index Transfer Operations

Other Index Operations

The Document Boxes

Document Transfer Operations

Local Document Administration Operations

The Document Filters

RandeX Usage (Normal User Mode)

The Basic Browser

The Document Search Tool

RandeX Scanning Mode

The Basic Browser

The Scan Manager

Image Processing Options

Troubleshooting

The "How can I..." quick guide

Frequently Asked Questions

Known bugs

RandeX Contact Addresses

About RandeX

What is RandeX?

Resource Adaptable Network Document EXchange.

RandeX is a Client-Server Internet application which basically works as a scanned document database allowing different hosts to interchange documents in an easy way. Its intended to be a multi-platform software, though this first version is compiled only for Windows 95.

Setting up RandeX

What do you need:

o A PC computer with Windows 95 operative system

o A great amount of free hard disk space if you plan to have a huge quantity of scanned documents permanently stored.

o A valid IP address for your PC.

o A Printer (connected to the PC or available via LAN)

Optionally:

o A Twain compliant scanner with a 32 bit driver. (If you cannot get your scanner working with RandeX, check that you are really using a 32 bit driver).

The distributed files:

RandeX consists of a Server application and a Client GUI application.

Server file: SERVER.EXE

Client GUI Application file: RDX_GUI.EXE

Documentation: MANUAL.DOC (Wordpad file)

All remaining files are created when any of the applications is started the first time.

Setting up RandeX:

As far as RandeX is under developement, the installation process is not provided with an installation helper program, but it is in fact rather easy to install.

o Create a directory for RandeX binaries, for example C:\RandeX\bin. Copy the two distributed files into that directory.

o Then edit your AUTOEXEC.BAT file and add the following line (be sure to avoid blank spaces beside the '=').

SET RANDEX_PATH=C:\RandeX\bin

Reboot your computer so that the change takes effect.

o Edit your Windows Desktop and add two links wherever you want, one for each of the RandeX applications. For example, you may create a RandeX group and the two links under this group. You may also want to add a RandeX Server Application link icon to your Startup group.

o Execute the RandeX GUI Application (RDX_GUI.EXE). If no error occurs, the Main RandeX Client Panel should appear. Otherwise, review your Autoexec.bat file or the names of the directories or applications, reboot again and execute the RandeX GUI Application.

o After executing RandeX GUI, a Database directory structure should appear, starting at C:\RandeX\bin\db, as well as a default initialization file called RandeX.INI and possibly some LOG files in the same directory of the executables.

o Press the button in the Randex GUI Panel. This will create a password for the administrator. By default it's set to a single carriage return (ENTER). So press ENTER while in the Password text box, and then press the 'Change' button to set up a new custom password. Now simply follow the instructions in the hint text box.

IMPORTANT: This is a test version of RandeX, so the administrator password is not encoded. It's simply stored in the initialization file (RandeX.INI) as is.

o RandeX's basics are now set up. If you want (and dare) to make any change to the RandeX.INI file, this is the moment (read about RandeX.INI variables just below). Be sure to close the GUI Application first. Note that if you change any of the paths, some of the newly created database structure may become obsolete, and new database directory structures may be re-created.

o To begin managing with communications, start both the RandeX Server Application and the RandeX GUI Application. Read about RandeX Database Administration below for more information.

o Now RandeX is installed and set up, but you'll get error messages if you try to get any document information, cause no document is still present at the database. You may wish to go to the 'RandeX Database Administration' section if you want to manage with documents right now.

RANDEX.INI Variables

The default RandeX.INI file contains all the possible initialization variables currently supported by RandeX and a little explanation about every one of them. We complete here that information. Note that if you change any of these values, both RandeX Server and GUI applications shouldn't be running (RandeX.INI file is wrote and read by both applications). Otherwise, inconsistency errors may occur. The default values for all variables are perfectly valid for most of the cases, so avoid changes if they are not necessary.

o DATABDIR

Default value: RANDEX_PATH\db

This is where the database root directory is located. Any time you change this value, a new database will be created (or accessed if already exists) under the specified path. In normal use, this variable shouldn't be changed.

NOTE: If you change the database, you should then set any of the new database local indexes as Document Receiver Index (see 'RandeX Database Administration') or you won't be able to receive any document.

o TEMPDIR

Default value: RANDEX_PATH\db\tmp

This is where the database temporary files are stored. You may change this as you wish, but make sure that both RandeX applications are not running when changing it.

o FIRSTINDEX

Default value: RANDEX_PATH\db\randex.rdx

This is the Main RandeX Database IndeX. It shouldn't be changed unless you need to create different databases in the same directory structure, useful only when debugging; in other cases changing this may be really harmfull, mixing or overwriting information from different databases.

o SEARCHRESULT

Default value: RANDEX_PATH\db\search.rdx

This file is used to store the result of the last document search process. You may change this value any time, but usually not necessary.

o DEFAULTDUMPINDEX

Default value: (The hash key of the local document index)

Do not change this value!!. Instead, you may want to use the RandeX Administration Panel to change the Document Receiver Index. As you read before, this operation is needed whenever you change the Database Root directory or the Main Database Index file name.

o CODEDADMINPASSWD

Default value: (None, you should set up one password using RandeX GUI)

This is the Password for the RandeX Administrator. In future non-test versions, this password will be coded.

o ALLOWUSERPRINTING

Default value: 1 (On)

This variable indicates if normal users are allowed to send documents to the local printer. 1 means 'Yes'; 0 means 'No'. Administrator is always allowed to print documents.

o ALLOWUSERSENDING

Default value: 0 (Off)

This variable indicates if normal users are allowed to send documents to remote RandeX hosts. 1 means 'Yes'; 0 means 'No'. Administrator is always allowed to send documents.

o COMPRESSIONTYPE

Default value: 1 (LZW compression)

This variable indicates if there will be compression after scanning (and perhaps preprocessing) a document. 0 means 'No compression'. Other values sets the type of compression: 1 means Liv-Zempel compression; 2, RandeX native compression without losses, and 3 means RandeX compression allowing losses.

This RandeX test version only uses standard LZW methods for document image compression.

o SKEWCORRECTION

Default value: 1 (On)

If this variable is on, skew correction and stain removal is performed after scanning (or importing) a new document image. 1 means 'Yes'; 0 means 'No'.

o LOGFILENAME

Default value: RANDEX_PATH\startup.log

This is the file where the RandeX GUI Application database management log messages are dumped to. You may change this name as you need.

NOTE: Local and Internet communication messages are logged into a different log file (clidebug.log).

o LOGDEBUGLEVEL

Default value: 1

The level of debug indicates how many messages are dumped to the log files. This variable sets the Debug Level for the RandeX GUI Application. A level of 0 means that no message is dumped. 1 is the recommended for normal use, dumping only error reports. More than 1 (up to 4) may create too huge logs, only useful for debugging.

NOTE: If you find any abnormal behaviour in RandeX, you may set this level to 3 or 4 and send us the log file of a short session, but restrict the session to those actions concerning the strange behaviour, so that we can process the debug log file easier.

o SERVERLOGFILENAME

Default value: RANDEX_PATH\server.log

This is the same as LOGFILENAME, but for the RandeX Server Application.

NOTE: Local and Internet communication messages are logged into a different log file (serdebug.log) but only if the server is executed with the -d2 command line option.

o SERVERDEBUGLEVEL

Default value: 1

This is the same as LOGDEBUGLEVEL, but for the RandeX Server Application.

Leave as default for normal use. Set to 3 or 4 if you need to send us a session's log.

RandeX GUI Application

 

The RandeX GUI Application should be started for every session. It shows the following Main GUI panel.

 

Main RandeX GUI Application panel.

View/Print/Send Document

This command opens the basic database browser with Viewing, Printing and Sending options. By default, only the administrator is allowed to print and send documents to remote RandeX hosts, but it may be configured so as to allow any user to print or send documents. A document search tool is included in this panel. Searches may be done through a single index or through the entire database.

Scan Document

This command is only available for RandeX administrator. It opens nearly the same database browser, but includes a 'Scan' (or 'Re-Scan') and 'Import' buttons. Documents may be Searched, Viewed, Printed, Scanned, just from this panel.

Image Processing Options Setup

Open a window for setting preprocessing tools and different compression methods of text and images. Document image files are compressed using these settings.

See help on 'Image processing Options Setup' for more information about the available options.

RandeX Database Administration.

This button opens the main whole database administration panel. It is only available for RandeX administrator. The RandeX Database Administration Panel gives full control over all indices and documents. Documents may be created, edited, deleted, copied from one index to other, sent to or requested from other hosts. Indices may be created, deleted, sent to or requested from other hosts.

See help on 'RandeX Database Administration' for more information in the following sections.

About RandeX GUI Application

Opens a small dialog box with a short information about RandeX GUI Application. In the future, it will open the RandeX Help file (still not available).

RandeX Password Input

Opens the Administration Password management panel used to enter/change the administration password. The default value of this password is and empty line (a single ENTER), but you should change it when installing RandeX. The Administration Password panel is shown below.

The current mode is shown in the status line at the right bottom corner of the RandeX GUI Application Panel. Note that opening some of the accessable panels during an Administration Session, gives full access to the database, and changing to User Session does not have effect on already opened windows. You should close all administration panels to ensure that no administration actions are performed by users.

RandeX Quit button.

Quits RandeX GUI Application. RandeX service is given by the RandeX Server Application, so this GUI can be quitted with no problem, leaving the Server running.

RandeX Server Application

The server application should be always running in the RandeX host. It attends all requests from remote RandeX hosts and from the local RandeX GUI Application.

Note that if no Server is running, all outgoing requests can be performed by the RandeX GUI Application (you can send and ask for documents to remote hosts without the server application), but no information can reach the local machine, cause the Server is the only who is attending incoming calls. Also note that if you request a document, the answer (the document coming to your host) is an incoming call, attended only by the Server Application, so you won't receive the document, though the remote system did send it to you.

RandeX Server Application Panel

The RandeX Server Application has no command available because it runs as a daemon. No action is to be performed on its panel. You can minimize it after starting it up. The only actions in the menu bar are 'Quit', which quits the RandeX Server Application, and 'Help-About', which opens a dialog box with a short info about the application itself.

RandeX Database Administration

The RandeX Database Administration Panel gives full access to the database structure. It is only available in Administrator Mode (see the status line at the right bottom of the RandeX GUI Application Panel). To switch to Administrator Mode, press the button and enter the correct password.

It is highly recommended to follow the hints into the lower status lines. They will guide you through all operations. The right one usually shows the result of your operations, while the left one uses to show hints about what you should do for every next step, or what is the meaning of the box where you are going to enter text.

About Document organization.

Documents are grouped into Indices. Every RandeX host should have a Local Index containing the information of all documents stored in its hard disk, scanned or not, but at least the document information (the bibliographic register or Document Information) and copies of all (or at least most) of the remote RandeX hosts.

A Local Index is created the first time that RandeX is executed. A RandeX host manager may want to have more local indexes to group Documents by subject, procedence, status, ... All these Indices are treated as the first one.

Document information (the bibliographic registers) are stored as records inside Indices. The scanned pages are stored under subdirectories (as multipage TIFF images in this version of RandeX). The TIFF file names are obtained by combining the Document's Identificator (ISSN, ISBN or Custom), the Volume number of the publication and the starting page of the document inside that publication's volume. As RandeX was thought to be a 16 bit application, the names of these files were cut to 8+3 characters, so it could run under MS Windows 3.xx.

These names are still kept with that length and all three identification fields are coded into the name, giving strange names like $%GN/%&.5(I. Maybe this restriction will be discarded for later versions, breaking the compatibility with MS- Win3.xx and a possible MS-DOS porting.

All Indices and Documents are managed through the RandeX Database Administration Panel, which is shown below. However, when you open the Administrator, only Indices information and operations are show.

This initial window is divided in two panels. The left side one is only for indices located at the local host, and the right side one can hold local or remote indices.

If you click on any of the buttons, the document information panels are displayed. Next figure shows the expanded window. For returning to the "only indices information" window, push .

The panel is divided in four sections. The two left side boxes are only for local data (indices and documents located at the local host) and the right side boxes can hold local or remote hosts data.

The Local Index Box.

This box is used to browse or modify the structure of the local indexes. When starting RandeX the first time, the Local Index is created, with all the necessary directory structure which will hold the documents' info and pages. You do not need to create more indices, at least while having a few documents.

Local Index box.

 

 

The text boxes

Index .- Shows the name or description of the current index. The first index automatically created in the host is always called "Index at [your host name]". You cannot modify this, but can create other indices and later delete this one. This box is a pop up list which displays all available Local Indices. Press the down arrow beside it to pop it up.

Host and IP .- The Internet name and IP address of your host. This is what other remote RandeX hosts will read as your host name when answering your requests, so be sure that it is correct. This version of RandeX does not allow to edit Index parameters, so if these fields are not automatically filled correctly, then create a

new Index and delete this one.

Path .- The (sub)directory where documents belonging to the current index are to be stored. If no drive letter or backslash is given at the begining, it is supposed to be a path under DATABDIR (see RandeX.INI variables above). Get used to specify relative paths instead of full paths, except for the case of CD-ROM RandeX indices (there is still no one, but will be) where the path should include the CD drive letter and so. The first index data path is created as the IP address of the host in hexadecimal.

IDX .- The name of the database file which holds the records of the documents stored in the current Index. As well as the Path, this file name may be a full path filename or a relative filename. The second is the preferred way except for pre-created indices in other paths or drives. The first index data file is created as the IP address of the host in hexadecimal, with the IDX extension.

NOTE: Be sure not to give the same name to the Path and the IDX fields, because while the directory will be created, the IDX file creation will return an error.

The buttons:

Index Type (No menu command).

This button is enabled only while entering the Index parameters. An Index may be set up as a 'Local Read/Write Index', 'Local Read Only Index' or 'Private Index' (and 'Remote Index' too, but only indices received from remote hosts are automatically set up to 'Remote'). Press it repeatedly to change the choice:

Local Read/Write .- It is a normal Index. Documents can be stored into or removed from it. These Indices are sent to remote hosts when they request any Index.

Local Read Only .- For this version of RandeX, Read Only Indexes are treated the same way as Read Write ones. No write permission checks are performed.

Private .- These are only for local administration purposes. They are never sent to remote hosts. A Private Index may be set up as Document Receiver, which will prevent other RandeX systems from receiving unclassified lists of recently received documents.

Remote .- This mark is automatically set up on received Indices.

While this button is not available for pressing, it always shows the status of the currently displayed Index. Note that once an Index is set up as one of the available types, it cannot be changed later.

Create New Index (Menu command: Index | New)

Clears the Index parameters fields and prompts for an Index description. The all remaining fields should be filled in. When finished, press again the 'New' button, which will look like while editing. Once you have finished entering the new Index parameters, you will see the following box:

The first option (Insert Index information and create the directory structure) is the default method and creates all the necessary structure for mantaining documents inside it.

The second one (Insert information and create the Index data file) will store the Index data and create the Documents' data file (the IDX database file), but not the documents' pages subdirectory. This may be useful when creating an Index database with already scanned documents from any existing directory, for example, when reconstructing any damaged database.

The third option (Only insert Index information), will create the Index, but will not create any file or subdirectory. This may be useful when inserting existing databases, for example, from a CD-ROM with its own Index data file.

If you press the 'Cancel' button in this box, the Index creation will be aborted.

Delete Index (Menu command: Index | Delete Left).

This button will delete the currently displayed Index. It will prompt you for confirmation as well as for the deletion method. The following choice will be shown:

The Deletion methods are inverse to those for creating new Indexes. Choose that method according to what you wand to delete.

NOTE: Non-empty document directories will never be automatically deleted by RandeX.

IMPORTANT: If the Index you are going to remove is the 'RandeX Document Receiver' (that is, the Index where your RandeX Server will dump all received documents into), you will be prompted and adviced. If you delete it, then you need to set any other local index as Document Receiver (see 'Receiver' button below), or you will not be able to receive documents.

Edit Index Parameters (Menu command: Index | Edit Description).

This action is not available in this test-version of RandeX. If you need to modify an Index, create a new one with right parameters, copy the documents into it, and delete the old one. This will be fixed in the next release.

Reorganize Current Index (Menu command: Index | Reorganize Current).

RandeX uses a free database engine (gdbm) which needs to have database files reorganized every long time. Deleted records are not really deleted until a reorganization is performed. If you have deleted a reasonable quantity of documents from an Index, you should reorganize it so that the size of the data file can be decreased according to the new amount of information.

Reorganization time depends on how many documents are remaining into the Index. It may last from almost a second to a few minutes.

Set Document Receiver (No menu command).

At least one of the Local Indices must be a Document Receiver. That is, an Index where the RandeX Server Application will dump received documents into. This button sets up the currently displayed Index as Document receiver. If the Index is already the receiver, the button is unavailable and a checkbox beside it is marked on.

Local /Remote Index Section

The Local/Remote Index Section is similar to the Local Index Section except for the available actions and for the fact that it displays remote Indexes as well as local Indexes. For example, next figure shows the displayed box for a remote index.

Local/Remote Index Section

The text boxes:

All text boxes are the same as in the Local Index Section, except for the pop up list, which displays either Local or Remote hosts' Indices (see the 'Local/Remote' button below).

The buttons:

Index Type (No menu command).

This button is similar to the previously described button, but is always disabled (no editing is performed in this section) and only shows the type of the currently displayed Index, now including the 'Remote' choice.

Set Remote host name manually (No menu command).

When asking for Indices or documents to a remote RandeX host which is not yet in our database, the Internet name or IP address must be supplied (one of them). By pressing this button, a text box will be displayed so that the administrator can type the remote host name or IP. It will be put into the Local/Remote Index Section's text boxes and all remote operations can be performed. To return to an already known host Index, you only have to select it from the pop up list. A new choice named < Host Address Set Manually > is available to return to the entered host name.

Delete Index (Menu command: Index | Delete Right).

The Deletion action is the same as for local Indexes. Also, this button can remove Local Indices as well as Remote ones, prompting the same questions as explained above.

Toggle to or Indices (No menu command).

This button selects if the Local/Remote Index Section will display Local indices or the Remote ones (if there are). This may be useful when performing some kind of local-only management, preserving the remote hosts' indices.

Index Transfer Operations

An Index transfer consists of sending or receiving both the Index information itself and all the documents' information inside the transferred Index (not the documents' image data, but only the bibliographic registers).

The four buttons for Index Transfer Operations are only available if the right side Index Box contains the specification of any remote RandeX host. Otherwise, buttons and the corresponding menu options are disabled.

The buttons:

Send Index to Remote (menu command: Index | Send to Remote)

This buttons transfers the currently displayed local Index at the left side Index Box, to the host whose name and IP address are shown at the right side Index Box. Note that the remote host will receive the Index data and will overwrite any old copy (making a backup copy first) of our Index.

The Index will be sent if it is not empty (contains any document).

Request Index from Remote (menú command: Index | Request from Remote)

This action requests the specified Index at the right side box from the corresponding remote host. Any old copy of that Index at our local host will be overwritten after making the proper backup copy. If no Index description is present when requesting an Index (for instance, after manually entering the IP address of the remote host), all Indices will be requested, the same as pressing the button (see below).

If the requested Index is empty, the remote host will refuse to send it.

Note that it is necessary to press the Reload button (see below), in order to update the display after receiving the requested index.

Send all Indices to Remote (menú command: Index | Send all to Remote)

Sends all available and non-empty Indexes from our local host to the remote.

Request all Indices from Remote (menú command: Index | Request all from Remote)

This button requests all available and non-empty Indexes from the specified remote host, no matter which one is currently displayed at the right side box.

Other Operations on the Database Indexes

Reorganize Main Database (menú command: Index | Reorganize Main)

This button performs reorganization over the RandeX Database Main Index (that one pointed by the FIRSTINDEX RandeX.INI variable. Reorganization of the Main Index is recommended after deleting some local or remote Indexes.

Reload Database (menú command: Admin | Reload Indexes)

Working with RandeX requires the presence of the RandeX Server Application running in parallel with the GUI Application. So the Server may alter database contents while receiving new information (new Indices or Documents). The RandeX GUI Application should reload the Database as soon as all Server's transfer progress indicators reach the 100% (which means that all current tranfers have been completed). By pressing this button, the RandeX Database Administration Panel refreshes all information, including recently received Indices or Documents.

Document Boxes

The Document boxes show the document list for each of the two currently displayed Indexes, as well as the Bibliographic Information of the currently selected document from the documents list.

 

Document Information Section

Shows the Bibliographic information of the currently selected Document. Note that this information may not be automatically displayed; see the Box Refresh options below. All fields are also empty when no document is selected from the list.

Documents List

Shows all available documents from the currently selected Index from the Index Box just over the Document Box. A vertical scroll bar will be displayed if necessary.

List Selection

The List Selection Choice Box shows the field which will be displayed into the Documents List. Possible choices are Title, Author, Ident, FileName and Publication.

(Some of them like FileName are only for low level administration, actually).

Box refresh options

This section controls the automatic filling of the Document Information fields. If the checkbox is checked, the fields will be automatically updated when a document is selected. If not, the button must be pressed every time that the information should be shown.

Document Filter Options

The button opens the Document Filter Panel. There is one different filter for each of the lists. See Filter Boxes below for more information about Document Filtering.

Document Transfer Operations

Document Transfers operate in two different ways, depending on what kind of Index is currently shown into the right side Index Box. If the displayed Index is a local one, transfers are simple copy procedures, which transfer both Document Information and Document Image Data from one to another local Index. If the displayed Index is a remote one, transfers are Send and Request Messages between the two RandeX hosts.

Send Document to Remote / Copy Document to Right Index

(menu comand: Document | Copy -> or Document | Send to Remote )

While a remote Index is selected at the right side Index Box, this command sends the currently displayed document from the local Index (left side box) to the remote host. No matter which one of the remote Indices is selected, only the host name and IP address are taken. The host itself will insert the document into its 'Document Receiver' Index.

When the right side Index box shows a local Index, this button simply copies the Document Information and Document Image Data to the right side index.

Request Document from Remote / Copy Document to Left Index

(menu comand: Document | Copy <- or Document | Request from Remote )

While a remote Index is selected at the right side Index Box, this command sends a request to the remote host, asking for the currently displayed Document at the right side box. It is up to the local administrator to have recently updated copies of the remote Indexes, so that no obsolete information is being asked for. It may be a good method to ask for Indices just before asking for Documents.

When the right side Index box shows a local Index, this button simply copies the Document Information and Document Image Data from the right side to the left side one.

Send All Documents to Remote / Copy All Documents to Right Index

(menu comand: Document | Copy all -> or Document | Send all to Remote )

Request All Documents from Remote / Copy All Documents to Left Index

(menu comand: Document | Copy all <- or Document | Request all from Remote )

These two buttons perform the same actions as and but over all of the currently listed documents in the left or right side Document Box lists respectively. Note that no multiple selection is allowed in the List Boxes, but selection may be done by using the Filters (see Document Filters below).

Local Document Administration Operations

Document Administration Operations may only be done with local (left side box) indices. The following actions are allowed from the Administration Panel. It is highly recommended to follow the hints in the lower status bars. They will guide you while executing every operation. Click on the text fields to view a hint about them.

Create a New document (menu command: Document | New )

Clears the Document Information fields and creates a new document entry. The Administrator should type in the information for every one of the following fields:

Title: The title of the article, paper, book,...

Author: The author's or authors' name(s).

Year: Publication year.

Type: Type of document (article, paper, book, ...).

1st Page: The page of the publication where the document starts.

Publication: The name of the publication.

Volume: Volume number of the publication.

Identification & Identifier Type: An ISSN, ISBN or Other kind of identifier for the publication. The Id. Type box must be selected with the right choice according to it. See the left side status bar for hints on how to enter Identifiers.

Pages: Number of pages of the document (not the publication).

Printed: The number of available printouts at the local library. This field is never automatically filled, so the Administrator must fill it when a printout is made.

And optionally:

Scanned pages: This is automatically filled in by the Scan Manager. However, the Administrator may want to give this any value. (Not recommended; the document viewer is based on this information to check if a document is scanned or not).

The Key Fields are the Identifier, the First Page and the publication's Volume Number. All these fields must be correctly filled in and no coincidence between documents will be allowed. We consider that a document is uniquely referenced by these three fields.

Delete the current document (menu command: Document | Delete )

This button deletes the currently selected document in the left side Document Box. Both Document Information and Document Image Data will be deleted from the local Index and hard disk, after a confirm notice.

Edit the current document (menu command: Document | Edit )

This allows the administrator to edit most of the Document's Information fields. Title, Author, Year, Type, Publication and Scanned Pages are editable. The rest of the fields are not editable due to be automatically filled in or due to be part of the Document Key. To alter the Key (Identifier, Ident. Type, 1st Page, Printouts or Vol. number) you should delete it, create a New document and re-scan or import it.

The Filter Boxes

When working with lots of documents or when searching for a specific one, it may be useful to select only some of the Documents in the Indices; those matching a string or substring in any of the information fields. Note that for a filter be active, the checkbox beside the button must be checked. Otherwise, filter selections does not have effect.

One of the List Box Filter's Panel.

The String selection fields must be filled in with the strings or substrings to be searched for. The Size field is a numeric one and matches the documents whose size is less than the specified, unless it is zero (means not compared).

The ISSN, ISBN and Other checkboxes are checked by default. A check means that all documents with that kind of Identifier, will match.

Filter options

These options are

- Scanned Documents: Match only those which have at least one scanned page.

- Printed Documents: Match only documents which have been printed out.

- Scan Requested: Match documents which have been requested by any remote host and are still pending to be scanned.

- Exact Strings: If checked, strings are compared as entire strings, but not as substrings.

- Case Sensitive: If checked, strings are compared case-sensitively.

The buttons

Apply Filter (menu command: Filter | Apply )

This button stores the filter parameters in memory. If the filter is active (the checkbox beside the button is checked), the Documents in the List Box will be immediately re-read and filtered.

Close Filter Box Panel (menu command: Filter | Close ).

Closes the Filter Box panel, keeping all filter settings intact and functional.

Cancel last changes (menu command: Filter | Cancel ).

Cancels the last changes on filter selections, loading the last Applied filter.

Clear Filter fields (menu command: Filter | Clear fields ).

Loads the default filter, which matches any document.

Help (still unavailable) (menu command: Help | Help ).

RandeX Usage (Normal User Mode)

When using RandeX as a "non-administrator" user only some functions are available, all of them in the Basic RandeX Browser. The following picture shows this browser with all its posibilities (some of them are not always available, depending on the use) .

Index Selection/Information.

Document browsing can be performed through any of the existing indices. The user may select to view the local or remote ones by pressing the corresponding toggle button, and then select the index to browse using the choice box.

Document information.

These fields show the Bibliographic Register data of the currently selected document (Title, author, publication, year, identification,...) and two check boxes that indicate if the document is locally scanned or if any printed copy is available (this last box must be updated by the administrator; see RandeX Database Administration above).

Document selection.

These two buttons select the PREVIOUS or the NEXT document in the currently selected Index or Search results.

Document Search Tool.

Search Tool Panel.

This button opens the Search Tool panel, which is used to search for a specific document or to make a pre-selection of documents before browsing. After accepting the Search results, a new "SEARCH RESULTS" index will appear in the Index Selection box, and a new text box with the different Index descriptions will be shown above the document information section.

See Using the Document Search Tool below for more information.

Recall Last Search.

This button recalls the last search results, so the user may review it again after browsing single Indices. The Last Search Result is stored so that it is available even after closing the RandeX Applications. (See RandeX.INI variables).

Tool Buttons

View Document Pages

This function opens the View panel where document pages are shown.

Print Document Pages

This button opens the Windows's Printer Dialog box so as to print all or some of the document pages. If only the Administrator is allowed to print out documents, an advice box will display a message.

Send Document to Remote

Asks for a remote host IP or Address and sends the currently selected document.

Though this button is always visible, it runs only if Users are allowed to send documents, or when in Administrator Mode. Otherwise, an advice will be displayed.

Close Basic Browser

Closes the Basic Browser panel. Note that Search results are always kept even when closing the entire applications.

Help (still unavailable)

It will open the Help file about the Basic Browser.

The Document Search Tool.

The Document Search Window is shown in the following figure:

 

Selected Index

If the Search All Hosts checkbox is not checked, the search will take place only through the Index shown in this text box.

Search Filter Parameters

Fill in whatever you wish the documents to match to. Strings are compared case sensitive or insensitive, exact or substring, depending on the search options below, but no wildcard is accepted.

Search Options

Scanned documents will match only documents with at least one scanned page.

Printed documents matches only those stored with at least one available printed copy.

Pending to be scanned is an Administrative search option which will match any document that has been requested by any remote RandeX System but is not locally scanned. The Administrator should search for these documents and scan them when possible, so that the remote RandeX hosts can re-request them and get them.

Search for Exact Strings makes the search tool match all documents with exactly the specified strings (empty fields are not compared, but any non-empty field should match entirely).

Case Sensitive search makes the search tool not to ignore the case when comparing fields. The search is Case Insensitive by default.

Items Found

This box shows the number of matching documents after performing the search.

The Action Buttons

Perform Document Search

Starts searchig for documents matching the strings into the Search Filter Parameters textboxes. This does not quit the Search Tool Window, because the user may want to refine the search parameters if too many documents are found.

While searching, the left side status bar shows the progress of the search.

Accept the Search Results

This button accepts the search results and quits the Search Tool Window, returning to the Basic Browser. This browser will show now those results. Note that the upper Index listbox shows the "-- SEARCH RESULTS --" text inside, while a new textbox is now available and shows the Index which the displayed document belongs to. This is because different documents belonging to different Indices and hosts may appear in the search result, if using the Search all hosts option.

Note that to return to any Index, the upper listbox may be used. To recall the search results, click on the button.

Cancel Search

This button closes the Search Tool window returning to the Basic Browser, but it does not show the Search Results. Instead, the browser status is kept untouched. The Search Results file, however, contains all the last search information.

Open Help about the Search Tool (still unavailable)

This button will open the online help file about the Search Tool.

RandeX Scanning Mode

Only the RandeX System Administrator is allowed to scan or re-scan documents. This window shows nearly the same Basic Browser of the preceding section. However, since it is intended to perform scanning operations, there is some differences. Next figure shows this Basic Browser for Scanning.

The Basic Browser

It holds the same elements described in the preceding section. However, now there is no choice between local or remote indices. Only local ones are shown, because we only can scan local documents. As a consequence of this, do not appear a Send / Request button.

In the Document Information there are two new textboxes, showing the Filename of the Document Image Data and its Size. If it is not scanned, the size is zero.

Moreover, there is two new Tool Buttons:

(Re)Scan Document

It opens the Scan Manager so as to scan or re-scan the currently selected document.

Import Document

It opens a file selector to import an existing TIFF file. This file will be taken as the scanned image of the document, so it will be processed as the scanner output files.

This option may be very useful for testing RandeX when there is no scanner support.

The Scan Manager

This window interfaces with the specific Scanning Application supplied with the scanner. So, its look will be the same under other operating systems like Unix. The button bar is briefly explained below.

Select: For selecting the image source for the document. Normally, it is a TWAIN compliant scanner, but it could be a video or stand digital camera, for example.

Acquire: This button opens the native image acquisition program supplied with the scanner.

Unscan: Removes the scanned pages, no matter we have just scanned them or they were scanned before. The status bar will be set to 0. Note that cannot cancel later!

Preview: This feature is unavailable under Windows; use the acquisition software facilities instead.

Close: Exits the Scan Manager.

Cancel: Exits the Scan Manager, but discarding the recently scanned pages if there are.

Help: Unavailable in this test version.

Image Processing Options

The Image Processing Options window has two main sections, the first one related to preprocessing and compression and the second one to decompression. The user is allowed to select some parameters that will make effect when some determined actions are performed on the document, for instance scanning, importing or viewing a document.

The default values are read from the RandeX.INI file (see RandeX.INI variables section).

In the first section we can select preprocessing or not at all. If the former was chosen now we can define what kind of processing we want on our document: binarization, skew correction and compression.

Binarization is disabled in this test version because only black&white (that is, already binarized) images are allowed.

Skew correction, that also performs a stain removal processing, corrects badly scanned pages.

When compression is chosen two different compression methods are possible: LZW and RandeX. The latter gives greater compression and has a lossy mode.

In the second section we may choose to get a preview of a decompressed document if it was compressed using the RandeX mode. The reason for this is that for this mode decompression takes a while to be completed.

RandeX compression and descompression items are disabled by now for being in a developement stage and will be included in next version.

By pressing this button the marked options are saved in the RandeX.INI file, and these options will apply for the subsequent scanning or importing operations.

Closes the window. Remark: if the chosen options have not been saved with Accept, all the changes are discarded.

Opens the online help. (Still not available).

The 'How can I...' quick guide.

How can I create a new Index?

Open the RandeX Database Administration Panel.

Click on the button from the left side Index box. An Index description will be prompted for. And all left side Index box fields will be cleared.

Enter the appropiate local Host Name, IP Address, Path Name (a single directory name is enough, without full path) and the Index Name (IDX) (a single file name, usually the same as the Path name but ended with '.idx'). Be sure that all directory and file name don't already exist.

Select the type of Index pressing the button. Choices are: LocalR/W, LocalRO and Private. Private Indexes are not visible to other RandeX hosts, and they are used as local management Indices.

Press the button. A choice box will be displayed.

Select the Index Creation Method and press the OK button (See Database Administration for more information about methods).

How can I delete a local or remote Index?

Open the RandeX Database Administration Panel.

Select the Index from the any Index box's pop-up list, or from the right box if deleting a remote Index (of course, our copy of the remote Index, but not the remote :-))

Press the button from the appropiate Index box.

... I'm requested to confirm, because I had selected the Receiver Index.

Then confirm if you are sure, but remember to set up another local Index as Receiver after you finished the deletion. Otherwise, you will not be able to receive documents.

A choice box asks for the deletion method. Select according to the desired (the most of the times this will be according to the creation method) and press the OK button. For remote Indices, the first or second choices are the same.

How can I import Indices from a known remote host?

Open the RandeX Database Administration Panel.

Be sure that you RandeX Server Application is running.

If you have any Index from the desired host, just select it. Otherwise, you will have to press the button and enter either the IP Address or the Host Name.

Press the button. All remote Indices will be downloaded (of course, if the remote host is running the Server Application too).

Wait a while and press the button to make changes available.

How can I refresh an old remote Index?

Open the RandeX Database Administration Panel.

Select your old remote Index from the right Index box.

Press the between the Index boxes. RandeX will then download the most recent version of that Index from the remote host.

A backup copy of the old index will be stored, but not available via the RandeX GUI Application (only for administration purposes).

How can I create a new document?

Open the RandeX Database Administration Panel.

Select the Index where you want to add the document, from the left Index box.

Press the button between the Document boxes. All document fields from the left side box will be cleared and ready to be entered new text.

Type in all fields except for Filename and Filesize (Scanned and Printed should be usually left untouched too).

When finished, press the button (just where the button was before).

The document information is stored. Now it rests to scan it.

How can I delete an existing document?

Open the RandeX Database Administration Panel.

Select the Index where you want to delete the document from, also from the left Index box.

Select the Document from the left Document box.

Press the button (between the Document boxes).

You will be prompted for a confirmation and then the Document will be deleted.

How can I edit an existing document?

Open the RandeX Database Administration Panel.

Select the Index where you want to edit the document from, also from the left Index box.

Select the Document from the left Document box.

Press the button (between the Document boxes).

Walk through the left Document box fields editing whatever you want to modify (not all of them are available for editing).

When finished, press the button (just where the button was before).

The document information is stored. Scanned pages are kept untouched.

How can I scan an existing document?

Open the RandeX Database Basic Browser for scanning.

Select the Index where you want to edit the document from.

Select the Document from the index.

Press the button (below the document information).

Follow the steps as explained in the Scan Manager Section.

Troubleshooting

My RandeX GUI Application gives an error message when opening the basic browser (Found no document).

o Probably the first index that is present at your database is empty. Put any document into the index or simply delete that empty index.

I have lots of filenames like M&/$%25$.%)) in my database directories.

o Don't worry. Due to the principles of RandeX developement as a Win3.xx Application, document names had to be shortened to 8+3 characters, and the entire document reference had to be encoded into that length, causing names like those. The names are correct.

My RandeX doesn't receive anything from remote RandeX hosts.

o Check that your RandeX Server is running.

o If the server is running and still no host can reach you, execute the RandeX GUI Application and check the header of the STARTUP.LOG file for any error message, possibly related to retrieving the local IP address. If the message exists, then check your Internet connection and TCP/IP protocol configuration.

My RandeX cannot receive Documents from remote hosts, though it receives Indices.

o Maybe you have deleted your RandeX Document Receiver Index. Check that you have any of you Local Indices set up as Receiver. If not, set up one of them.

o If you have already a Document Receiver Index, check that the Receiver Index parameters are correct and that its directory structure is not damaged and is fully accessable for the RandeX Server Application. Check also the path strings into your RandeX.INI

My RandeX crashes after scanning one page.

o Maybe you are scanning full coloured images. Up to now, RandeX only supports binarized (black & white) image scanning and viewing, and 256 gray image scanning (but not viewing or printing). Scanning any full color image will make it crash (or at least it will cause unstability). See Known Bugs below.

I cannot view an apparently scanned document (RandeX crashes).

o First of all make sure that the document is really scanned: check that the filename matches that one stored in the documents' data. Maybe the document's file has been erased or the "Scanned Pages" field has been erroneously edited. In future versions, more file checks will be performed.

My RandeX Administration Panel does not show any Document in one or both Document boxes, though Indices are holding some of them.

o Maybe you have any filter set up. Chech the Filter checkbox out or open the Filter panel so as to clear all fields.

Known bugs:

RandeX supports only black & white images. Scanning of 256 gray images is possible but viewing color or gray images will make it crash.

RandeX Contact Addresses

RandeX is being developed by the Signal Theory Group (GTS) at the University of Vigo (Spain).

E-mail: RandeX@tsc.uvigo.es

WebPage: http://www.tsc.uvigo.es/RandeX/

Phone: +34 86 812675

Fax: +34 86 812116

Mail: Signal Theory Group.

Escola Técnica Superior de Enxeñeiros de Telecomunicación

Universidade de Vigo

Lagoas - Marcosende

36200 Vigo

SPAIN


Back to ISTEC Library Initiative

http://www.istec.org/liblink/jerome/rdxmanual.html