Query

Allows you to submit a natural language, Boolean, bracketed Boolean, keyword, field, or fuzzy query to IDOL server.

Example

PQF syntax:

http://12.3.4.56:6000/action=Query&Text="Abyssinian Bobtail"
http://12.3.4.56:6000/action=Query&Text=@and fat cat
http://12.3.4.56:6000/action=Query&Text=@attr 1=4 @attr4=1 “hot tin roof”

CQL syntax:

http://12.3.4.56:6000/action=Query&Text="Abyssinian Bobtail"
http://12.3.4.56:6000/action=Query&Text=fat and cat
http://12.3.4.56:6000/action=Query&Text=title="hot tin roof"

This action uses port 6000 to request documents that are conceptually similar to the specified Text from the Z39.50 server which is located on a machine with the IP address 12.3.4.56.

Parameters

Parameter Description Required
AgentBooleanField A field that contains Boolean agent expressions  
AgentSecurityField A field that contains the SecurityInfo for secure documents in AgentBoolean queries.  
AutoPhrase Whether to apply automatic phrase quotations to all terms in the query text.  
CaseSensitive Determines the case sensitivity of field specifiers.  
DAHEndState Sets the maximum number of results to print.  
DAHStartState Prints results from only this position forward.  
DatabaseMatch The database to retrieve results from.  
FederatorParams A list of parameters to append to a query to Federator child engines.  
FieldRestriction The fields that restrict the query terms.  
FieldText Applies field restrictions to results. see Comments
FieldTextField A field whose content must be used as the query’s FieldText.  
HardFieldRestriction Specifies that the fields in FieldRestriction are the only fields allowed in the matching process for both Text and FieldText.  
MaxResults The maximum number of results to return.  
SecurityInfo The security details.  
Sort The display order of results.  
Start Prints results only from this position onwards.  
StateDontMatchID The state token of a group of documents to not return.  
StateMatchID The state token of a group of documents to return.  
StoreState Whether to store results in a state token.  
StoredStateDetail Returns Engine and EngineIndex elements for each document returned, as well as child server details.  
Text The query text. see Comments
TextParse Extracts TextParseIndexType fields from the specified Text and uses them for AgentBoolean querying.  
TotalResults Displays the total number of results found.  

This action accepts the following standard ACI action parameters.

Parameter Description
ActionID A string to use to identify an ACI action.
EncryptResponse Encrypt the output.
FileName The file to write output to.
ForceTemplateRefresh Forces the server to load the template from disk.
Output Writes output to a file.
ResponseFormat The format of the action output.
Template The template to use for the action output.
TemplateParamCSVs A list of variables to use for the specified template.

Comments

PQF (Prefix Query Format) and CQL (Common or Contextual Query Language) are external query formats used for Z39.50 servers.

You must set one of the following parameters or parameter combinations:

NOTE:

You cannot use the Delete parameter or any parameters that specify document IDs. Use parameters that identify documents by their references instead.


_HP_HTML5_bannerTitle.htm