PlanetPress Search User Guide www.objectiflune.
©2010 Objectif Lune Inc -2-
Copyright Information Copyright Information Copyright © 1994-2011 Objectif Lune Inc. All Rights Reserved. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any other language or computer language in whole or in part, in any form or by any means, whether it be electronic, mechanical, magnetic, optical, manual or otherwise, without prior written consent of Objectif Lune Inc. Objectif Lune Inc.
©2010 Objectif Lune Inc -4-
Table of Content Table of Content Copyright Information 3 Table of Content 5 Overview 7 Icons used in this guide 7 Other Documentation 7 Understanding PlanetPress Search 9 Search Profile 9 Search Database 10 PDI File 10 The PlanetPress Search Program 11 Start PlanetPress Search 11 The PlanetPress Search Program Window 11 The Search Toolbar 12 The Search Panel 13 Basic Search 13 SQL Search 14 The Search Results Panel 15 Set User Options 15 Change Language 17 Exit Planet
Table of Content Create a PDF of Search Result Pages 34 Print PDF Pages Referenced by Search Results 34 Print a Summary of the Search Results List 35 Copy Information from the Results List 35 Advanced Concepts 37 Sharing A Profile On The Network 40 Database Structure 40 Command Line Rebuild and Refresh 41 The Command 41 Parameters 41 Example Usage 42 Notes 42 Database Considerations in a Network Installation 42 ©2010 Objectif Lune Inc -6-
Overview Overview This PDF documentation covers version 7.4. To view the documentation of previous versions please refer to the PDF files available in the Downloads section of our website: http://www.objectiflune.com/OL/Download/DownloadCenter. Icons used in this guide Some icons are used throughout this guide in order to catch your attention to certain particular information. Notes: This icon shows you something that complements the information around it.
©2010 Objectif Lune Inc -8-
Understanding PlanetPress Search Understanding PlanetPress Search This chapter explains how PlanetPress Search works and how to configure it to search one or more PlanetPress Image archives. There are three key points to understand with respect to how PlanetPress Search works: 1. Every search you perform is done on a search database that PlanetPress Search builds from the information in the PDI files generated by PlanetPress Image.
Understanding PlanetPress Search Search Database A search database, sometimes referred to simply as a database, is what PlanetPress Search searches when you perform a search. The database contains the index information for the documents in one or more PlanetPress Image archive folders. You create, update, and search a database through a search profile. PDI File You create the index terms for a document in PlanetPress using data selection objects.
The PlanetPress Search Program The PlanetPress Search Program Start PlanetPress Search 11 The PlanetPress Search Program Window 11 The Search Toolbar 12 The Search Panel 13 Basic Search 13 SQL Search 14 The Search Results Panel 15 Set User Options 15 Change Language 17 Exit PlanetPress Search 17 Start PlanetPress Search Since version 7.
The PlanetPress Search Program You use the Search Configuration area to configure and launch a search. The currently loaded search profile determines what search database is available in the Search Configuration area. See "Determine the Currently Loaded Search Profile" (page 27) for help determining which search profile is currently loaded. The Document box near the top of the Search Configuration area contains a list of all documents in that database.
The PlanetPress Search Program l l l l l l l l l l l l New: Click to display a submenu where you can create a new search profile. Open: Click to open an existing Search Profile. Save: Click to save the current Search Profile. Save As: Click to save the current Search Profile as a new file. Print: Click to print the search results (only active when search results are available). Copy Selected Nodes: Click to copy the selected search results to the Windows Clipboard.
The PlanetPress Search Program Primary Sort Order: Determines how the search results will be sorted (results are always ascending). The 3 available options are: l Document name: Sorts by the name of the document (the same as the ones seen in the Document drop-down above). Note that selecting this option when filtering by document results in no sorting at all. l Date: Sorts by document creation date. l PDF Name: Sorts by the PDF file name.
The PlanetPress Search Program The SQL Search Panel is used to give much more control and power while creating a search query. It is assumed that some knowledge of SQL Queries is available to the user before he attempts to use this tab. To search using the SQL tab: 1. Enter your SQL query in the SQL Query box 2. Click Search to execute the query. The default search query for an Access Search Database (which returns all PDFs in the database) is this: SELECT DISTINCTROW Table_ PDF.PDF_ID, Table_PDF.
The PlanetPress Search Program l l to the currently loaded search profile. Filter date: Select the date filter that appears by default when PlanetPress Search loads this search profile. The date filter appears in the Date boxes in the Search Configuration area of the PlanetPress Search Program window, and constrains the search to PDFs created during the specified time period. Select None to include all PDFs. Use default profile: Select to specify a search profile to load on startup.
The PlanetPress Search Program Change Language This procedure describes how to change PlanetPress Search’s display language . To change the PlanetPress Search display language: 1. Choose Options | Select Language. 2. Select the new language. 3. You can also enable Use System Default Locale to mirror your language settings, as defined in the Regional and Language Options of the Windows Control Panel. Exit PlanetPress Search This procedure describes how to exit PlanetPress Search.
©2010 Objectif Lune Inc - 18 -
Search Profiles And Databases Search Profiles And Databases In order to give the ability to search your document archives, PlanetPress Searchmust use a database in the background, with which it connects using a Profile. While you may have multiple profiles on one or more computers connecting to a single database, a search profile can only connect to a single database. This chapter explains how to set up and manage profiles and databases.
Search Profiles And Databases l l l l An SQL Server driver must be installed on the system (this is available by default in any supported version of Windows) The currently logged on user must have access to the SQL Server instance through the network. A database must be created on the SQL Server. It is suggested to call the database Search. A username and password must be defined in the user options and this username must have access to the SQL Server and its Search database (see Set User Options).
Search Profiles And Databases 4. 5. 6. 7. In a network installation, the folder must be one to which all users have read access. It is not necessary for the folder to be mapped on individual user computers but they must be able to access it through its Universal Naming Convention (UNC) file name (\\servername\sharename\path\filename). The default folder for the database is the PlanetPress Search program folder. In the Select Directory dialog box, click OK.
Search Profiles And Databases Create a New Search Profile that Uses a MySQL Database This procedure describes how to create a search profile that uses an MySQL database. Pre-Requisites for MySQL database connectivity: l l l l A MySQL driver must be installed on the system (available on MySQL.com) The currently logged on user must have access to the MySQL server through the network. A database must be created on the MySQL server. It is suggested to call the database Search.
Search Profiles And Databases A. Navigator pane B. Archive folders list C. Add arrow D. Remove arrow Navigate TO A FOLDER Navigatorpane: Use to navigate to each folder you want to include in the database. add OR REMOVE archive folderS Add arrow: Use to add a folder to the Archivefolders list. Click the folder you want to add then click the Add arrow. You can also add a folder by clicking a folder in the Navigator pane and dragging it to the Archive folders list.
Search Profiles And Databases 4. In PlanetPress Search, choose Options | RebuildDatabase. PlanetPress Search prompts you to confirm the build. 5. Click Yes to confirm. PlanetPress Search populates each record in the database with the information from all of the PDI files associated with the document referenced by that record.When it completes this operation, the newly built database is available for searching.
Search Profiles And Databases 4. Click Yes to confirm. PlanetPress Search populates each record in the database with the information from all of the PDI files associated with the document referenced by that record. When it completes this operation, the newly rebuilt database is available for searching. Refresh the Contents of a Database The procedure here describes how to refresh a database from PlanetPress Search.
Search Profiles And Databases A rebuild of a search database rebuilds it from scratch. Thus when you rebuild a database, you can change the archive folders you want to include in the database. See "Refresh the Contents of a Database" (page 25) and "Rebuild the Contents of a Database" (page 24) for help refreshing and rebuilding a database. Save a Search Profile You can save the currently loaded search profile at any point.
Search Profiles And Databases search profile in a text editor and edit it, PlanetPress Search overwrites those edits when you switch to a new profile or exit PlanetPress Search. 2. Open the search profile in a text editor, make the necessary modifications, save the file and exit the text editor. Note that whether you can save the modified profile depends on the permissions set on the folder and file containing the search profile.
Search Profiles And Databases 1. Verify that no search profile references the database you want to delete. 2. Do one of the following: l If the database is a Microsoft Access database, in Windows, navigate to the folder containing the database and delete the database file archives.mdb. Whether or not Windows can delete the database depends on the permissions set on the database file and the folder that contains it. l If the database is an SQL Server database, see the database administrator.
Searching in PlanetPress Search Searching in PlanetPress Search This chapter explains how to define and launch a search. It also explains what a search result is in PlanetPress Search and the operations you can perform on search results. Once you have a search profile that references a search database, you are ready to perform a search in PlanetPress Search.
Searching in PlanetPress Search index term on that page of the PDF. If you search all documents in the database, the search result includes only identically named index terms common to all the documents. PlanetPress Search presents the set of search results as a Results list. The first level of the list represents individual documents in the search results. A. Results list B.
Searching in PlanetPress Search You can increase the size of the Results area within the PlanetPress Search Program window. See "Change the View on Search Results" (page 31).
Searching in PlanetPress Search Search Configuration area revealed ©2010 Objectif Lune Inc - 32 -
Searching in PlanetPress Search Search Configuration area hidden Select Search Results This procedure describes how to select one or more search results in the Results area. To select one or more search results: 1. If you performed a search on all documents in the database, expand the document in the Results area that you want to select search results from. PlanetPress Search displays the results below the document in the Results list. 2. In the Results list, click a search result.
Searching in PlanetPress Search selected search result. PlanetPress Search highlights each search result you add. For example: View the PDF Associated with a Search Result This procedure describes how to display the PDF page associated with a search result. To view the PDF associated with a search result: l Do one of the following: l Double-click the search result. l Click the search result and choose File | Open PDF. l Click the search result and, in the Results list, right-click and choose OpenPDF.
Searching in PlanetPress Search 1. Verify that the Printer to use option (in the User Options dialog box, Printing options) is set to the printer you want to use, and that the Multi-page option (in the User Options dialog box, Search options) is set as you require. Recall that the Multi-page option determines whether PlanetPress Search includes additional pages with each of the pages referenced by the Results list, and, if so, how many. See "Set User Options" (page 15) if necessary. 2.
Searching in PlanetPress Search PlanetPress Search copies the information for each of the selected results to the Windows Clipboard. 4. In an external application, use the Paste command to paste the contents of the Windows Clipboard into that application.
Advanced Concepts Advanced Concepts Sharing A Profile On The Network 40 Database Structure 40 Command Line Rebuild and Refresh 41 The Command 41 Parameters 41 Example Usage 42 Notes 42 Database Considerations in a Network Installation 42 Search Profile Contents Overview A search profile contains two categories of information: information about the search database itself and information about searches on that database. 1.
Advanced Concepts Note that with the exception of the ReadOnly and ShrinkToFit entries, all entries are either set through the PlanetPress Search user interface, or maintained automatically by PlanetPress Search.
Advanced Concepts Entry: Description before being saved in the search profile. PlanetPress Search prompts you for path to an Access database when you create a new search profile, or attempt to load a search profile that does not yet have a database associated with it. In the case of SQL Server databases, it prompts you for the information from which to construct a connection string when you create a new search profile.
Advanced Concepts DatabaseTimeout=300 [PathList] Path1=F:\sales\letters Sample Connection Strings The following are sample DatabaseDirectory entries that contain connection strings for an SQL Server database. The first in each pair presents the case where the user name and password on the database is the same user name and password the user uses to log on to their computer and run PlanetPress Search.
Advanced Concepts PlanetPress Search database structure. Tables Values and Relationships PlanetPress Search index values (INDEX_#) are associated with the page number (Page_Number) in the PDF Table_ (PDF_ID) they appear in. Each of the PlanetPress documents that generate a PDF which PlanetPress Search can Doc_# query has a unique Table_Doc_# table. Table_ PlanetPress documents are associated to a unique Doc_ID integer.
Advanced Concepts l l (-rebuild|-refresh): Mandatory. Use -rebuild to empty the database and rescan all PDFs in the search folders, or refresh to scan for any new PDFs in the search folders and add them to the database. ["c:\path\to\profile.prf"]: Optional. Specifies the search profile to be used. If no profile is specified, the default profile for the currently logged on user (C:\Documents and Settings\lachance\Application Data\Objectif Lune\PlanetPress Suite 7\PlanetPress Search\ppsearch.
Advanced Concepts search profile that prevents database updates, saving it out under a different name or in a different folder, and editing the ReadOnly entry to permit database updates. The only way to prevent this is to ensure users cannot write to the database from outside PlanetPress Search.
Advanced Concepts Name: Value: information from both PDI files in that record. The name, minus the file name extension, of this PDI file (and its corresponding PDF file). You set this name ~ArchiveFile in your PlanetPress Suite Workflow Tool when you configure the PlanetPress Image output task. The type of file (PDF, TIFF, or JPEG) generated by PlanetPress Image.
Advanced Concepts Chu Chin ~FieldName=department Marketing ~FieldName=years 1993 1998 2001 ~Page=2 ©2010 Objectif Lune Inc - 45 -
©2010 Objectif Lune Inc - 46 -
