|
Siebel Search Administration Guide > Siebel Search Integration API Reference >
Search Method
This method is used to invoke a basic search operation from the third-party search engine. Syntax
InvokeMethod ("Search", InputArgs, OutputArgs)
The Search Type tag in the InputArgs XML string must be set to BASIC.
NOTE: Both the Search and AdvancedSearch methods are invoked by passing Search as the pMethodName value in InvokeMethod calls. The Search Type tag determines which method is invoked.
Arguments
|
|
inputArgs |
An XML string containing the input for the search operation, such as the engine parameters, query, and keyword. For sample format and values, see Search inputArgs Example. |
outputArgs |
An XML string of search results returned by the third-party search engine. This argument is required. For sample format and values, see Search outputArgs Example. |
inputArgs Tags
The following search method inputArgs XML tags are used by the third-party search adapter. Other inputArgs tags are used internally by the Siebel application.
|
|
BCType |
Business component, for example, Contacts or Solution. Syntax example: 2#15#Service Request8#Contacts The first character denotes the number of business components in the search operation. 15 and 8 denote the number of characters after #.
|
Query |
The filter query string to determine which records are searched against. For example, First Name::Anil$$@@Last Name::Goyal$$@@ This query string executes a search against records where the First Name is Anil and the Last Name is Goyal. First Name and Last Name are fields in a business component. $$@@ is the delimiter used to separate terms in a query. |
SelectedSearch |
The selected searchable category in the Siebel Search Center Look In list. The search category also corresponds to the Name parameter in the Search Administration Search Index Settings view, for example, Solution (call center). |
Freetext |
The text to search for. This is the input from the Search For field in the Siebel Search Center. The freetext string can include any wildcard or Boolean operators supported by the third party search engine, for example, Ora* AND Sieb*. |
Collection |
The search data source, for example, business component or file system. The Collection value uses the same syntax and delimiters as BCType, for example, 2#7#buscomp11#File System. |
From, To |
The sequence of result records to request from the search engine, for example, values of from=0, to=9 indicate a request to return the first ten records from the search results. |
outputArgs Tags
The following search method outputArgs XML tags are used by the third-party search adapter. Other outputArgs tags are used internally by the Siebel application.
|
|
TotalRecords |
The total number of records in the search results. |
From, To |
The sequence of records from the search results currently displaying. For example, values of from=0, to=9 indicate the first ten records from the search results. |
<RecordDetails> |
The remaining OutputBlock tags contain the result record details, for example, business component type, document type, result summary, date, and data source. |
Usage
Use this method to process and return the search results from the third-party search engine. Invoked From
Invoked by the third-party adapter from InvokeMethod. Return Value
An XML string of search results returned by the third-party adapter.
|
