Search 2.5 PerformSearchInPublication

Executes a full text search on content and metadata within a publication and returns you the result set.

  • The main map and resources of the publication version, together with its baseline, are used to determine a list of all objects (maps, topics, library topics, images, ...) and their specific versions that are referenced (recursively) in the publication. To also include referenced objects that do not have a version in the baseline of the publication yet, you can specify a baseline autocompletemode to determine the version to use (e.g. ISHLastestAvailable). (The autocomplete will be done with the working language and resolution of the publication).
  • The list of all referenced objects and their versions, together with the languages and resolutions provided in the search query is used to gather the specific language objects (language cards) from the database. (If no languages are provided, the working language of the publication is used. If no resolutions are provided, all resolutions are used).
  • The list of all language objects is passed on as an additional filter to the SolrLucene search, thus limiting the search to objects in the publication only.
The results of this function will always be sorted on score descending (=most relevant matching search criteria first).

Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant.
psLogicalIdStringInThe logical identifier of the object
psVersionStringInOutThe version of the object. When no exact version is given, the version number will be returned.
peAutoCompleteModeeBaselineAutoCompleteModeInIndicates which Autocomplete mode must be used to select the version in the baseline report.
psXMLQueryStringInQuery XML structure containing the metadata for the full text search.
plMaxHitsToReturnLongInIndicates the maximum number of hits to return for the executed query.
plHitsTotalNumberLongOutIndicates the total number of hits found for the executed query.
psOutXMLSearchResultsStringInOutThe Search Result XML structure with the search results

Note that:
  • Due to the additional processing of the baseline, object versions, autocompletemode, ... to determine the language objects that are actually referenced in the PerformSearchInPublication before starting the search in SolrLucene (which the PerformSearch does not), a PerformSearch will execute faster but will not limit the search to objects in the publication.
  • If no ishlanguagefilter is passed in the psXMLQuery, this function will only search in objects in the working language of the publication.
  • If no resolutions filter (<ishfield name="FRESOLUTION" ..>) is passed in the psXMLQuery, this function will search in all image resolutions.
  • Read security will be applied on the search results.
  • The search will be handled on the application server by InfoShare's Full-Text-Retrieval engine which is a combination of the Trisoft InfoShare Crawler service(s) and Solr Lucene.

  • A search result list will only contain content objects. A content object is the combination of a language level, combined with the information of its version and of its logical level. This means that objects that only have a logical and version part cannot be found using this search function.
  • The parameter plMaxHitsToReturn can contain the following values:
    ValueDescription
    0The search is executed and the total number of hits is returned, BUT the results are not returned
    Exact number (e.g. 500)If there are more than 500 records, the first 500 records will be returned.