Controlling query execution

Some query elements have optional properties that control how a query is executed by the XML API. Our query engine operates by evaluating several logic rules in series. Each rule focuses on certain fields in the query, with the first rule processing the entire query. If any rule returns a single metadata record as its output, this DOI is taken as the result for the query, and rule processing terminates.

Controls include:

  • Match: use to specify level of fuzzy or exact matching. This attribute may be applied to several elements (ISSN, author, issue, article_title)
  • Enable-multiple-hits: allows or prevents matches returning more than one DOI
  • Secondary-query: instructs the system to perform a specific query if the default query mode does not produce a result. Current options include author/title, multiple hits, and author/title multiple hits.

Table of query controls

querykeystringto track a query to its results
queryenable-multiple-hitsfalse (default)have the system reduce the query to one DOI and return nothing if it can not do so
queryenable-multiple-hitstruehave the system return one DOI for each query rule it executes
queryenable-multiple-hitsmulti_hit_per_rulehave the system return many DOIs for each query rule it executes - will produce up to 50 candidate DOIs which partially match the query
queryenable-multiple-hitsexactrule processing is disabled, all DOIs matching a simple comparison to query values are returned
queryforward-matchfalse (default)no query is stored
queryforward-matchtruestore this query and re-run it automatically and notify via email any matches that are found
querylist-componentsfalse (default)components not included in results
querylist-componentstruelist the DOIs of any components that have deposited which are linked to this DOI
queryexpanded-resultsfalse (default)will not include article title in results
queryexpanded-resultstrueinclude article title in the results (only applicable when results format=XML_XSD)
querysecondary-queryauthor-titleperform author-title search if metadata search fails
querysecondary-querymultiple-hitsreturns multiple hits (if present)
querysecondary-queryauthor-title-multiple-hitsperforms author/title and multiple hits search if initial search fails
issnmatchoptionalvalue may be missing from deposited metadata
issnmatchexactmatch exactly as it appears in the query
journal_titlematchoptionalnot required
journal_titlematchfuzzy (default)use fuzzy string matching
journal_titlematchexactmatch exactly as it appears in the query
authormatchoptionalinstructs the query engine that this field may be ignored
authormatchfuzzy (default)use fuzzy string matching
authormatchnullmatch if author is missing in the metadata
authormatchexactmatch exactly as it appears in the query
issuematchfuzzy (default) / exact– see above –
first_pagematchfuzzy (default) / exact– see above –
yearmatchoptional (default) / exact– see above –
article_titlematchfuzzy (default) / exact– see above –

Page owner: Patrick Polischuk   |   Last updated 2020-April-08