XMetaL Author for SharePoint, Part 8 of n – Search

[nhu1]

Search

Multiple folders can be selected as search targets.

User can use Keyword Query Language (KQL) and/or Collaborative Application Markup Language (CAML) to specify search criteria.

KQL

• KQL can be enabled via [Repositories -> XMSP–Configure Settings -> Search -> Enable Keyword Query Language (KQL)].
  • It is disabled by default.
    • It should be disabled if SharePoint server is not configured to support KQL search.
  • It may require SharePoint administrator to configure the server to suit the user need.
• KQL is mainly for free-text(content) search or extensive managed properties environment.
  • https://docs.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference

CAML

• <Where>-clause specifies filtering criteria.
  • Simple <Where>-clause can be setup via [Conditions] grid form.
  • In [Conditions] grid form, a subset of fields is listed as candidates.
    • Use [Configure condition field candidates] to select the field candidates.
  • Complex <Where>-clause can be typed or pasted into the source view via

[Write CAML <Where>-Clause].

• For any arbitrary complex <Where>-clause that cannot be displayed in grid form.
• <Where>-clause must be wrapped in <Where>

• [Conditions] grid form provides the capability to create simple <Where>-clauses as below.
  • [condi_0] AND [condi_1] AND [condi_2] and …
  • [condi_0] OR [condi_1] OR [condi_2] OR …
  • [condi_0 AND condi_1 AND …] OR [condi_2 AND condi_3 AND …] OR …
• <ViewFields>-clause and <OrderBy>-clause can be setup via [Display Fields].
• Multiple values should be delimited by semicolon.
  • For example, [Check out to] [by any one of][username;username_2;…].
• <RowLimit> – apply to each search source (folder).

 

Search Result

• Search result is displayed in [Results Manager].
  • Search result contains only files based on their content and/or properties.
  • Each result item is associated with a set of operations.
  • Search result pane can be opened via [Repositories -> XMSP–Show Search Results].
• The result of KQL search is based on server crawling at configured time. Any immediate content change may not be included in the search result until the next crawling phase is finished.
• The number of items in the result set is displayed as tooltip when hovering the mouse over result set number (1, 2, 3, 4).
• The results can be filtered to only display a subset of items.
• [Details Actions] controls the visibility of KQL content snippets in the search results.

 

Search Plan

When constructing a search, the data can be saved as a search plan for future reuse.

• Common search plans can be created and distributed to multiple users.
• Search plans are saved in [%appdata%\SoftQuad\XMetaL Cms\SharePoint2\dat\query_plans\].

A regular search plan can be executed via context menu [Run Search] without going through the search dialog.

• When a user wants to modify the existing search plan (temporarily or permanently), the search dialog can be forced to display via clicking search plan name with Ctrl-key being held down.

Search Plan Template

• A search plan template is a regular search plan saved with [Template] ticked in the search dialog.
• When running a search plan template, search dialog is opened filled with search plan data. User can modify the data before executing the search.

Shared Search Plan

• When <Shared> is true, the search plan can be applied to any Document Library (not restricted to the Document Library from where the plan was created).

 

Reply

[Author]

Posts