Perceptive Search OLE Automation interface is designed to be used by scripts and other programs to perform search and access search results. This OLE Automation interface makes it possible to develop other tools or applications that use Perceptive Search, with scripting languages like JavaScript or VBScript. Please refer to Perceptive Search Macro Object Model for examples.
Constants
Objects
Extract results types, values can be ORed together, though some are mutually exclusive
| Const ExtractFileNames = 0 | Extract file names |
| Const ExtractTitles = 1 | Extract titles |
| Const ExtractResultList = 2 | Extract result list |
| Const ExtractToCSV = 32 | Extract to CSV |
| Const ExtractCategories = 128 | Extract categories |
| Const ExtractEntities = 256 | Extract entities |
| Const ExtractIncludeIndex = 512 | Include index information |
| Const ExtractIncludeDocNum = 1024 | Include document number |
| Const ExtractWordList = 2048 | Extract word list |
Enumeration of the available Perceptive Search Query types
| Const QueryCommand = 1 | Use command-style query |
| Const QueryNaturalLang = 2 | Use natural language query |
| Const QueryWebStyle = 3 | Use web-style query |
| Const QueryFindSimilar = 4 | Find similar |
Enumeration of output types for context extraction
| Const OutText = 0 | Use text format |
| Const OutCSV = 1 | Use CSV format |
| Const OutRichText = 2 | Use rich text format |
| Const OutHTML = 3 | Use HTML format |
| Const OutUnicode = 4 | Use unicode |
properties
| (Read-Only) Property ReadyState As Boolean | Query this to determine if Perceptive Search Query has completed its start up |
methods
| Sub ClearResults | Clears the Perceptive Search search results |
| Sub Close | Closes Perceptive Search Query |
| Sub DocActivate (DocNum As Long) | Activates the specified document in its native application |
| Sub DocHide (DocNum As Long) | Removes a document from the result list |
| Sub DocOpen (DocNum As Long) | Opens the specified document in the Perceptive Search browse window |
| Sub ExtractContext (toClipboard As Boolean, fileName As String, OutputFormat As Long) | Extracts the context of hits to the clipboard or a file |
| Sub ExtractResults (extractFlags As Long, toClipboard As Boolean, fileName As String, [includeDocNum As BooleanFalse]) | Extracts the current result list to a file |
| Function GetDataBase As String | Returns the current Perceptive Search index path, may be a semi colon separated list |
| Function GetDocCount As Long | Returns the number of document in the current result list |
| Function GetDocHits (DocNum As Long) As String | Gets the number of hits found in the document specified by the document number |
| Function GetDocLongName (DocNum As Long) As String | Gets the file name of the document specified by the document number |
| Function GetDocName (DocNum As Long) As String | Gets the file name of the document specified by the document number |
| Sub GetDocNum (DocNum As Long) | Gets the document number of the currently selected document |
| Function GetDocTitle (DocNum As Long) As String | Gets the title of the document specified by the document number |
| Function GetHitWord (WordNum As Long) As String | Retrieves the word specified by the word number parameter from the list of found terms |
| Function GetLine (DocNum As Long, LineNum As Long) As String | Returns the specified line of text from the specified document |
| Function GetLineCount (DocNum As Long) As Long | Returns the total number of lines in the document |
| Function GetMetaDataByName (DocNum As Long, MetaName As String) As String | Returns a meta data value by name (e.g. Title) |
| Function GetMetaDataLineCount (DocNum As Long) As Long | Returns the number of line of meta data in the document |
| Function GetQueryStats As String | Returns a comma separated list of number of hits, number of different words and total document from the current query result |
| Function GetRawFileName (DocNum As Long) As String | Returns the application native file name, eg EID for MAPI |
| Function GetResultLine (DocNum As Long) As String | Gets the specified result line, tab delimited |
| Function GetSavedQuery (queryNum As Long, QueryType As Long) As String | Gets a saved query by index, call GetSavedQueryCount first |
| Function GetSavedQueryCount As Long | Gets the number of saved queries available |
| Sub LoadResultList (fileName As String) | Loads a saved result list from disk |
| Sub Maximize | Maximizes the Perceptive Search Query window |
| Sub Minimize | Minimizes the Perceptive Search Query window |
| Function Query (QueryType As Long, OleQueryStr As String) As String | Performs a query of type ISYSQueryEnum using specified query string, return the number of hits, words and documents at a comma separated string |
| Sub Restore | Restores the Perceptive Search Query window to its previous state |
| Sub SaveResultList (fileName As String) | Saves a binary copy of the result list |
| Sub SelectIndex (IndexPath As String) | Selects an Perceptive Search index by specifying the path |
| Function Show As Long | Makes Perceptive Search Query visible |
| Sub ShowContext | Switches from result list view to context view |
| Sub ShowQuery | Shows the current Query input screen |
| Sub Sort (sortType As Integer) | Changes the sort order |
properties
| (Read-Only) Property Count As Long | Returns the number of documents in the category |
| (Read-Only) Property Name As String | Returns a category name |
methods
| Function ExecMethod (MethodName As String, Params) As Variant |
properties
| (Read-Only) Property Count As Long | Returns the number of items in collection |
| (Read-Only) Property Item (Index As Long) As IISYScategory | Returns an item from the collection |
methods
| Function ExecMethod (MethodName As String, Params) As Variant |
properties
| (Read-Only) Property ActiveTab As IISYStab | Returns an active tab |
| (Read-Only) Property Indexes As IISYSindexlist | Returns a list of available indexes |
| (Read-Only) Property Tabs As IISYStablist | Returns a list of open tabs |
methods
| Sub Close | Closes Perceptive Search Query |
| Function ExecMethod (MethodName As String, Params) As Variant |
properties
| (Read-Write) Property Flagged As Long | Marks the document as flagged (not flagged) |
| (Read-Write) Property Selected As Boolean | Marks the document as selected (not selected) |
| (Read-Only) Property AbsoluteFilename As String | Returns the absolute file name of the document |
| (Read-Only) Property Category As String | Returns the category of the document |
| (Read-Only) Property Date As Date | Returns the date of the document |
| (Read-Only) Property DateFirst As Date | Returns the first date of the document |
| (Read-Only) Property DateIndexed As Date | Returns the indexing date of the document |
| (Read-Only) Property Entities As IISYSentitylist | Returns the list of entities in the document |
| (Read-Only) Property fileName As String | Returns the file name of the document |
| (Read-Only) Property FileOnDisk As String | |
| (Read-Only) Property Folder As String | Returns the folder of the document |
| (Read-Only) Property Format As Long | Returns the format of the document |
| (Read-Only) Property FormatName As String | Returns the format name of the document |
| (Read-Only) Property HitCount As Long | Returns the number of hits in the document |
| (Read-Only) Property Index As String | Returns the document's index name |
| (Read-Only) Property ISYSID As Long | Returns the ID of the document |
| (Read-Only) Property Line (Index As Long) As String | Returns the specified line of text from the specified document |
| (Read-Only) Property LineCount As Long | Return the total number of lines in the document |
| (Read-Only) Property Metadata As IISYSmetadatalist | Returns the document's metadata |
| (Read-Only) Property Name As String | Returns the file name of the document |
| (Read-Only) Property Relevance As Long | Returns the relevance of the document |
| (Read-Only) Property Size As Long | Returns the size of the document |
| (Read-Only) Property Title As String | Returns the title of the document |
methods
| Function ExecMethod (MethodName As String, Params) As Variant | |
| Function Export (Dest As String) As Boolean | Exports the selected document |
| Sub Print | Prints the selected document |
| Sub Remove | Removes the selected document from result list |
properties
| (Read-Only) Property EOF As Boolean | Tests whether the document position is at the end of the collection |
| (Read-Only) Property Item As IISYSdocument | Returns a document from the collection |
methods
| Function ExecMethod (MethodName As String, Params) As Variant | |
| Sub MoveFirst | Moves to the first document in the collection |
| Sub MoveNext | Moves to the last document in the collection |
properties
| (Read-Only) Property CoreName As String | |
| (Read-Only) Property Count As Long | |
| (Read-Only) Property DisplayName As String | Returns the display name of the entity |
| (Read-Only) Property Type As Long | Returns the type of the entity |
methods
| Function ExecMethod (MethodName As String, Params) As Variant |
properties
| (Read-Only) Property Count As Long | Returns the number of items in collection |
| (Read-Only) Property Item (Index As Long) As IISYSentity | Returns an item from the collection |
methods
| Function ExecMethod (MethodName As String, Params) As Variant |
properties
| (Read-Write) Property CategoryLike As String | |
| (Read-Write) Property CategoryUnlike As String | |
| (Read-Write) Property DateAfter As Date | |
| (Read-Write) Property DateBefore As Date | |
| (Read-Write) Property FilenameLike As String | |
| (Read-Write) Property FilenameUnlike As String | |
| (Read-Write) Property Flag As Long | |
| (Read-Write) Property IndexedAfter As Date | |
| (Read-Write) Property IndexedBefore As Date | |
| (Read-Write) Property PathContains As String | |
| (Read-Write) Property PathOmits As String |
methods
| Sub Apply | Applies filter |
| Function ExecMethod (MethodName As String, Params) As Variant | |
| Sub Reset | Resets filter |
properties
| (Read-Only) Property Name As String | Returns an index name |
| (Read-Only) Property Path As String | Returns an index path |
methods
| Function ExecMethod (MethodName As String, Params) As Variant | |
| Sub IDBFunction (Method As String) | Executes Perceptive Search IDBFunction |
properties
| (Read-Only) Property Count As Long | Returns the number of items in collection |
| (Read-Only) Property Item (Index) As IISYSindex | Returns an item from the collection |
methods
| Function ExecMethod (MethodName As String, Params) As Variant |
properties
| (Read-Only) Property Count As Long | Returns the number of items in collection |
| (Read-Only) Property Item (Index) As String | Returns an item from the collection |
| (Read-Only) Property Key (Index As Long) As String |
methods
| Function ExecMethod (MethodName As String, Params) As Variant |
properties
| (Read-Only) Property Count As Long | |
| (Read-Only) Property Item (Index As Long) As IISYSmetarefineitem | |
| (Read-Only) Property Name As String |
methods
| Function ExecMethod (MethodName As String, Params) As Variant |
properties
| (Read-Only) Property Count As Long | |
| (Read-Only) Property Name As String |
methods
| Function ExecMethod (MethodName As String, Params) As Variant |
properties
| (Read-Only) Property Count As Long | Returns the number of items in collection |
| (Read-Only) Property Item (Index As Long) As IISYSmetarefine | Returns an item from the collection |
methods
| Function ExecMethod (MethodName As String, Params) As Variant |
methods
| Function ExecMethod (MethodName As String, Params) As Variant |
properties
| (Read-Only) Property Categories As IISYScategorylist | Returns a list of categories in the current result |
| (Read-Only) Property Count As Long | Returns the number of documents in the current result |
| (Read-Only) Property Entities As IISYSentitylist | Returns a list of entities |
| (Read-Only) Property Filter As IISYSfilter | |
| (Read-Only) Property Item (Index As Long) As IISYSdocument | Returns the specified document |
| (Read-Only) Property Metadata As IISYSmetarefinelist | Returns metadata |
| (Read-Only) Property Query As String | Returns the original query text |
| (Read-Only) Property WordList As IISYSwordlist | Returns a list of words in the current result |
methods
| Sub Clear | Clears the current result |
| Function ExecMethod (MethodName As String, Params) As Variant | |
| Function FetchAll As IISYSdocumentcollection | Returns a list of all documents |
| Function FetchFlagged (Flag As Long) As IISYSdocumentcollection | Returns a list of flagged documents |
| Function FetchPrompt As IISYSdocumentcollection | |
| Function FetchSelected As IISYSdocumentcollection | Returns a list of selected documents |
| Sub LoadAnswer (fileName As String) | Loads result list from a file |
| Sub SaveAnswer (fileName As String) | Saves the result list to a file |
| Sub Search (Query As String, QyeryType) | Performs a query of type ISYSQueryEnum using specified query string |
| Sub Sort (Method) | Changes the sort order |
properties
| (Read-Only) Property Categories As IISYScategorylist | Returns a list of categories for the tab |
| (Read-Only) Property Count As Long | Returns the number of documents for the tab |
| (Read-Only) Property Entities As IISYSentitylist | Returns a list of entities for the tab |
| (Read-Only) Property Filter As IISYSfilter | |
| (Read-Only) Property Item (Index As Long) As IISYSdocument | Returns the specified document |
| (Read-Only) Property Metadata As IISYSmetarefinelist | Returns metadata |
| (Read-Only) Property Query As String | Returns the original query text |
| (Read-Only) Property WordList As IISYSwordlist | Returns a list of words for the tab |
methods
| Sub Activate | Makes the tab active |
| Sub Clear | Clears the tab |
| Function ExecMethod (MethodName As String, Params) As Variant | |
| Sub ExecuteAction (Action As String, Options) | |
| Function FetchAll As IISYSdocumentcollection | Returns a list of all documents |
| Function FetchFlagged (Flag As Long) As IISYSdocumentcollection | Returns a list of flagged documents |
| Function FetchPrompt As IISYSdocumentcollection | |
| Function FetchSelected As IISYSdocumentcollection | Returns a list of selected documents |
| Sub LoadAnswer (fileName As String) | Loads result list from a file |
| Sub OpenIndex (Path As String) | Selects an Perceptive Search index by specifying the path |
| Sub SaveAnswer (fileName As String) | Saves the result list to a file |
| Sub Search (Query As String, QyeryType) | Performs a query of type ISYSQueryEnum using specified query string |
| Sub Sort (Method) | Changes the sort order |
properties
| (Read-Only) Property Count As Long | Returns the number of items in collection |
| (Read-Only) Property Item (Index As Long) As IISYStab | Returns an item from the collection |
methods
| Sub CloseAll | Closes all tabs |
| Function ExecMethod (MethodName As String, Params) As Variant | |
| Function New As IISYStab | Opens a new tab |
properties
| (Read-Only) Property Count As Long | |
| (Read-Only) Property Name As String |
methods
| Function ExecMethod (MethodName As String, Params) As Variant |
properties
| (Read-Only) Property Count As Long | Returns the number of items in collection |
| (Read-Only) Property Item (Index As Long) As IISYSword | Returns an item from the collection |