1

 

 

 

Retrieval Module 

Application User Guide 

August 2009 

 

Copyright 2009 PSIGEN Software, Inc., All Rights Reserved  This product and the accompanying printed and electronic materials are protected by copyright laws. You may not make or distribute copies of this product and the accompanying document, or decompile, decrypt, or reverse engineer this product. No part of this product and document may be reproduced or transmitted in any form or any means for any purpose, without the express written permission of PSIGEN Software, Inc. To the maximum extent permitted by applicable laws, in no event shall PSIGEN Software, Inc. be liable for any damages whatsoever arising out of the use of or inability to use this product and the accompanying documentation. Information in this document is subject to change without notice. The information contained in this document represents the current features of PSI:Capture as of the date of publication. Because PSIGEN responds to changing market conditions with new facilities, PSIGEN cannot guarantee the accuracy of any information presented after the date of publication.      

PSIGEN Software, Inc., 8 Goodyear Suite 110 Irvine, CA 92618 – USA

sales@psigen.com www.psigen.com

2

About this Guide 

This document is usually intended for use of a project supervisor. Typical tasks for such persons

include delegation of tasks and overseeing the progress of the document types. These

document types should be configured by an administer prior to the start of the capture process.

Refer to the Administrative Guide as necessary for information relating to configuration. 

 

 

 

About PSIGEN Software, Inc. 

PSIGEN Software is a fast growing, privately held, provider of document capture and retrieval software 

solutions.  Our  product  lines  address  production  capture,  distributed  capture,  web  based  retrieval, 

including the Microsoft SharePoint platform. Our  largest customers  include scanning service providers, 

business process outsourcers,  and  the  corporate  services divisions of  Fortune 500  corporations.   We 

have  significant  customer  concentration  in  financial  services,  healthcare,  and  manufacturing.  Our 

channel partners include document imaging value added resellers, major brand MFP dealers, Microsoft 

solution providers, and document management software vendors.  

 

 

 

 

 

 

 

3

Table of Contents

Retrieval Module Overview Page 4

User Interface Overview Page 4

Toolbar Banner Page 5

Retrieval Toolbar Page 5

Viewing Toolbar Page 6

Annotation Editing Toolbar Page 7

Navigator Pane Page 8 - 10

Retrieval Pane Page 11

Query Page 11 - 16

Query Results Page 17 - 19

Image Viewer Pane Page 20

Menu Bar Page 21

File Page 21 - 27

View Page 28 - 32

Security Page 33 - 35

Window Page 36 - 38

Help Page 39 - 40

 

4

Retrieval Module Overview

The purpose of the Retrieval Module is to offer the user quick way to query vast collection of

images and data within PSI:Capture’s repository or via a number of popular external databases.

This is a useful tool for reviewing/sharing completed work, by providing the ability to revise

indexed data, add annotations, and print/fax/email images.

User Interface Overview

The PSI:Capture interface is divided into different functional areas, as seen in the layout below.

These panes of the user interface will be referenced throughout this manual.

1. Toolbar Banner

2. Navigator Pane

3. Retrieval Pane

4. Image Viewer Pane

5

Toolbar Banner

Retrieval Toolbar

Close Module – Closes out the current module.

New Search – Clears the current data in Query/Results fields and Image Viewer, allowing

a new search to be performed.

Toggle Thumbnail Viewer – Pages are viewed as thumbnails in the Image Viewer

Pane.

Results View - Choose to view results in Form view or in Grid view.

Print – Prints the current page.

Email – Brings up the Mail Message Editor dialog box to send the image file of the page

currently in view as an attachment.

Work Queue – Displays a submenu allowing documents/pages to be queue for

printing or emailing.

Toggle Annotation Editing – Reveals the annotation editing toolbar and annotation

settings pane, which allows user to add commentary to the retrieved image.

Toggle Annotation Display – Toggle between the original document and the annotated

document.

6

Viewing Toolbar

Page Toggle – Allows User to go between pages in a

document, as well as go to the beginning and the end.

Rotate Left/Right– Provides the ability to rotate the document.

Pointer – Allows selection of a page or item.

Selection Zoom – Click and drag with your left mouse button to zoom-in on a selected

area on the image. To bring the image back to full size, double right-click.

Magnifier – When selected, a left click will magnify the area on the document.

Zoom Controls – Provides zoom-in and zoom-out capability, as well as a

drop down for fit page, fit width, actual size and zoom levels.

Toggle Standalone Viewer – Allows the image viewing pane to be detached. Mostly

used with a multi-monitor / large display setup.

7

Annotation Editing Toolbar

This toolbar is only visible if “Toggle Annotation Editing” is enabled.

Save Annotations - Saves the changes made to the image file.

Clear Annotations – Deletes the changes made to the image file.

Pointer – Changes the cursor back to the default mouse pointer.

Text Tool – Draws a box where specified text will be displayed.

Freehand Tool – Draws lines that follow the path of the mouse pointer.

Line Tool – Draw a straight line from point A to point B.

Polyline Tool – Draws multiple connected line segments.

Rectangle Tool – Draws a rectangle.

Polygon Tool – Draws a polygon.

Ellipse Tool – Draws an ellipse shape.

Stamp Tool – Stamps a box containing specified text.

8

Navigator Pane

Navigator Pane can either be pinned to the desktop (default) or set to auto hide.

Modules Tab

Capture / Import – Opens the Capture/Import module.

Quality Assurance – Opens the Quality Assurance module.

Index – Opens the Index module.

OCR – Opens the OCR module.

Retrieval - Opens the Retrieval module. NOTE: Availability dependent on license options.

Migration – Opens the Migration module.

9

Reporting – Opens the Reporting module.

Batch Manager – Opens the Batch Manager module.

Configuration – Opens the Configuration module.

Security – Opens the Security module.

Support Tab

Contains links to support website, support email, and view logs.

Support Web Site

Opens the default web browser to www.psigen.com/support

Email Support

Opens the default mail service for user to compose an email to support@psigen.com.

View Logs

Displays a list of logs containing all PSI:Capture modules.

10

Utilities Tab

Contains Barcode Generator module and Network Manager.

Barcode Generator

Opens up a utility for users to create/save/print custom separator/indexing barcode sheets.

Network Manager

Allows user to manage the port and IP settings for PSIGEN Platform Services and License

Server.

11

Retrieval Pane

User can input a query, and view results. There are two types of queries: Repository and

Database.

Query

User can retrieve captured images from PSI:Capture’s built-in repository for document types

that have a “Retrieval” workflow step.

Query Type

Select between one of the two query types: Repository or Database.

12

Query Parameters (Repository)

User can choose which repository and document type to search in.

By clicking “Manage,” the user can add or delete repositories via the “Manage Search

Repositories” window. This must be done first before it will appear in the “Repository to Search”

drop-down list. Simply point to the same directory as defined in the retrieval workflow of

Document Type configuration.

Query Parameters (Database)

User can choose which database and table to search in.

13

By clicking “Mange” the user can add or delete databases via the “Manage Search Databases”

window. This must be done first before it will appear in the “Database to Search” drop-down list.

Add/Edit

Brings up the “Database Configuration” dialog box.

14

The supported Database Types are: Microsoft Access, Microsoft SQL Server, Oracle, IBM DB2,

IBM Informix Dynamic Server, ODBC Complaint, and OpenLink Virtuoso Server, selected via a

drop-down menu.

Define a Database by clicking the “Select” button.

This brings up the “Database Connection Setup” dialog box. User can then browse for a

database. Enter ID login if the targeted database requires user authentication. Click “Test

Connection” to test accessibility.

15

Query Definition

User can define the search criteria to run a query.

Simple Query

One or more expressions can be defined using multiple index fields.

The operator for the expressions is set using the drop-down list.

16

Query Builder

Works exactly the same as the Simple Query, except the same index field can be used more

than once in multiple expressions, further narrowing the search.

Search

Once the expressions have been specified, click “Search” to initiate the query.

17

Query Results

The results of the query are displayed. Each column can be sorted and filtered by clicking on

the column heading or the filter tool.

Repository

Notes – View existing note(s) or attach new note(s) to a desired document.

18

Selecting the “New Note” button will bring up the “Document Note Entry” dialog box. Note and

author information are composed here.

Edit Index Data – Index data for a desired document can be changed.

NOTE: The ability to attach notes and edit index data is only available to Repository Query

Results.

19

Database

20

Image Viewer Pane

Displays the page(s) associated with the highlighted result. NOTE: An image will only be

displayed in the database contains a table that specifies the file path.

21

Menu Bar Contains drop down menus: File, View, Security, Window, and Help.

File

Contains numerous commands specific to the Retrieval module.

22

New Search

Clears the current data in Query/Results fields and Image Viewer, allowing a new search to be

performed.

Save Query

Saves the defined query for future use.

Save Query Only

Save only the query parameters and definition.

Save Query with Data Snapshot

Saves the query parameters and definition, in addition to the results.

Load Query

Opens a standard Windows Explorer, allowing the user to recall a previously saved query.

Toggle Thumbnail Viewer

Pages are viewed as thumbnails in the Image Viewer Pane.

Open New Viewer

Opens up a new viewer. Useful if the user wants to view multiple files simultaneously.

Open Image for Compare

Opens up Windows Explorer to select image file(s) to view from an external source.

23

Results View

Choose to view results in Form view or in Grid view.

Grid View

Repository Database

Form View

Repository Database

24

Toggle Annotation Editing

Enables a powerful toolset for user to add graphics, text, and other annotations to the data

image file.

25

Toggle Annotation Display

Toggle between the original document and the annotated document.

With Annotation Without Annotation

NOTE: The above example is an annotation using the “Stamp Tool” with the text “PAID”

Print

Prints the current page. User has the option to print the image with or without annotation.

Email

Brings up the Mail Message Editor dialog box to send the image file of the page currently in

view as an attachment. User has the option to include annotation with the attached file.

26

Work Queue

Documents/Pages can be queue for printing or emailing. Selecting this command displays the

following submenu:

Add Current Page to Queue

Adds a specific page to the work queue.

Add Current Document to Queue

Adds a specific document to the work queue.

Add All Documents from Current Query to the Queue

Adds all query results to the work queue.

27

View/Process Queue

Brings up the “Work Queue” dialog box where the user can choose to either Print/Fax or Email

the files in queue. There are also options to include annotations, print/email multiple files as

one, unselect/remove individual files, or clear entire queue.

To proceed, click “Process”.

Close Module

Closes the Retrieval Module. PSI: Capture will remain open.

Exit

Exits out from PSI:Capture.

28

View Contains numerous commands relevant to page viewing and navigation in the Retrieval module.

First Page

Jumps to the first page of the document.

Previous Page

Jumps to the page before the current page.

Next Page

Jumps to the page after the current page.

29

Last Page

Jumps to the last page of the document.

Rotate Right

Provides the ability to rotate the document right.

Rotate Left

Provides the ability to rotate the document left.

Page Layout

Simplex

The standard method of viewing, this shows one page at a time in the “Viewing Pane.”

Duplex

Shows two consecutive pages (top and bottom) in the “Viewing Pane.” This is useful to view

the front and backside of the page simultaneously.

30

Pointer

Changes the mouse cursor back to the pointer (from “Zoom” or “Magnifier”).

Selection Zoom

Click and drag with your left mouse button to zoom-in on a selected area on the image. To

bring the image back to full-size, double right-click.

Zoom In

Provides zoom-in capability.

Zoom Out

Provides zoom-out capability.

Zoom

Provides a menu for actual size, fit page, fit width and zoom levels.

31

Thumbnail View

Select this option to change the size of thumbnail images displayed in the Thumbnail Viewer

Pane. NOTE: "Toggle Thumbnail Viewer" must be enabled.

Thumbnail Image Sizes:

Smallest Small Medium Large

32

Annotations

Reveals the annotations command menu. These are the same commands found in the

annotations toolbar. NOTE: This menu item is only visible if “Toggle Annotation Editing” is

enabled.

Image Properties

Displays file and image information about the current page.

33

Security

Contains commands relevant to security in PSI:Capture.

View User Profile

Opens the View User Details dialog box.

View User Details

Properties

Displays details about the current user.

34

Roles

Displays the current user’s role settings as dictated by the administrator. See “Roles” in

“Security Module” in the User Manual.

History

Displays the history of the user’s login activity in PSI:Capture.

35

Print History

Opens the Print Preview window.

Print Preview

Displays the standard functions for viewing and printing, such as zoom options and page setup.

Export History

Exports the login history in a Microsoft Excel Workbook file. This allows user to save the log to a

desired location.

Switch User

Logs out the current user out from the PSI:Capture, and allows an alternate log in.

36

Window Contains commands relevant to the Image Viewer Pane in PSI: Capture.

Cascade

Cascades all open windows in the Image Viewer Pane.

37

Tile Horizontally

Displays all open windows horizontally in the Image Viewer Pane.

38

Tile Vertically

Displays all open windows vertically in the Image Viewer Pane.

Minimize All Windows

Minimizes all open windows in the Image Viewer Pane.

39

Help

Contains information and details about PSI:Capture.

View Logs

User can select either PSI: Capture Logs or Platform Service Logs.

Log Viewer (PSI:Capture Logs)

Displays a list of logs containing all PSI:Capture modules.

View Log

Pressing this button brings up the log in your default text file viewer.

40

Log Viewer (Platform Services Logs)

Displays a list of logs for Platform Services.

View Log

Pressing this button brings up the log in your default text file viewer.

Service Status (Local Services / Remote Services)

Shows the version and current status of the services.

Reset User Window Settings

Resets the Window settings to default.

License Agreement

Displays PSI:Capture License Agreement.

Update License

Updates PSI:Capture License with the License Server.

About

Shows PSI:Capture copyright information, maintenance expiration date, installed

modules/assemblies, and license agreement.