Defining custom search panels for DMF and Message

MacroView DMF and MacroView Message search panels can be customised by modifying the Search Mask XML definition file.

For information on where to find the XML definition file refer to FAQ: MacroView DMF and MacroView Message search panels.

Below is a sample of the supplied Email Search panel that ships with MacroView DMF and MacroView Message and its associated Search Mask XML definition.

Pictured: Default Email Search panel in MacroView DMF and MacroView Message

Search mask definition:
<?xml version="1.0" encoding="utf-8" ?>
<SearchMasks>
<Mask Name="Email Search" TrimDuplicates="False" EnableStemming="True" Scope="All Sites" >
    <Controls>
      <Control Name="mvTo" Type="Text" DisplayName="To" />
      <Control Name="mvFrom" Type="Text" DisplayName="From" />
      <Control Name="mvSubject" Type="Text" DisplayName="Subject" />
      <Control Name="mvImportance" Type="Dropdown" DisplayName="Importance" >
        <Item DisplayName="Low" Value="0" />
        <Item DisplayName="Normal" Value="1" />
        <Item DisplayName="High" Value="2" />
      </Control>
      <Control Name="FileExtension" Type="Hidden" Value="msg" />
      <Control Name="mvReceivedTime" Type="DateRange" DisplayName="Received Time" />
      <Control Name="mvHasAttachments" Type="Checkbox" DisplayName="Has attachments?" Value="0" />
      <Control Name="AllText" Type="Text" DisplayName="All of these words" SearchPredicate="FreeText" />
      <Control Name="mvCheckoutUser" Type="Checkbox" DisplayName="Checked out to me" Value="[Me]"/>
    </Controls>
    <SelectFields>
      <Field Name="mvSubject" DisplayName="Subject" />
      <Field Name="mvTo" DisplayName="To" />
      <Field Name="mvFrom" DisplayName="From" />
      <Field Name="mvReceivedTime" DisplayName="Received Time" Type="DateTime"/>
      <Field Name="Path" DisplayName="Url"/>
      <Field Name="SiteName" />
    </SelectFields>
</Mask>
</SearchMasks>

Understanding the search mask definition

Each additional search panel is defined between a new set of <Mask Name=”[MASK_NAME]”…> and </Mask> tags in the search mask definition. Each mask is made up of:

Panel name and scope definition
Panel controls
Result columns
Refiners (optional)

Defining the panel name and scope

Panel name

The panel name can be defined like this:

<Mask Name="Email Search" TrimDuplicates="False" EnableStemming="True"

Search scope

Search Scopes can be mapped to search across your entire tenant or server, or be limited to a custom result source. (Custom result sources were introduced in SharePoint 2013 and 2016.)

Using a search scope

By default, search masks will query the entire server or tenant. To set a custom search scope add the search scope to the mask definition like this:

Note: [SCOPE_NAME] must be a valid source.

For example, in a Dutch language implementation of SharePoint a valid Scope would be ‘Alle Sites’ (corresponds to All Sites in English). As illustrated above, the ‘Scope’ setting is optional, with 'mvAllSites' being used if it is missing.

Using a result source

You can also use Result Sources to target searches by specifying the result source in the mask header as follows:

For more information refer to Using result sources to target searches

Using term sets defined at the site collection

If your search panel uses the Search Taxonomy Control to allow the selection of a value from a managed metadata term set that is defined at the site collection, rather than the server or tenant, you must also specify the site collection URL where it is defined. See the following example:

* Note: 'SiteCollectionUrl' and other properties are case sensitive.

Where clause

You can also further limit the scope by adding a "Where" clause using a path or content type as follows:

Filtering by path

<Mask Name= "Email Search" TrimDuplicates="False" EnableStemming="True" Scope="All Sites" Where="path:https://my.sharepoint.com/sites/location/*" >

Note: The asterisk at the end of the path in the Where clause is required.

Filtering by content type

For more information refer to Filtering search masks on content type and Limiting results using "WHERE" in search masks

When using Search mode in the Save to SharePoint or Open from SharePoint window from an Office application, the file types returned are automatically filtered to include only applicable file types and to exclude folders and document sets. If your search mask is filtered by content type to return folders and document sets and you want these to work when using open from SharePoint and Save to SharePoint then you can add the IgnoreFileTypeQuery parameter to the mask definition and set it to True.

Duplicate Trimming

The ‘TrimDuplicates’ option in MacroView DMF search panels specifies whether or not duplicate items should be removed from the search results. The default behavior in MacroView panels, and the SharePoint UI, is to show duplicates. If this option is changed in your search panel XML definition, you may receive far less results than the equivalent browser search.

TrimDuplicates is defined in the <Mask> tag as follow:

Word Stemming

The ‘EnableStemming’ option in MacroView DMF search panels specifies whether the SharePoint search should use word stemming. Stemming is a process where the endings of some words are stripped off to facilitate a search that returns results including related words, such as ‘kick’, ‘kicks’ ‘kicking’, ‘kicked’ etc. The default behavior in the SharePoint UI is for stemming to be disabled. The default behavior in MacroView panels is for stemming to be enabled. You can modify your search panel XML definition if you would like to match the browser search.

EnableStemming is defined in the <Mask> tag as follow:

Defining the panel controls

The controls on the search panel are defined between the <Controls> and </Controls> tags. Each individual control is defined between a <Control> and </Control> tag.

In the above email search panel example, a text control labelled “To” is defined and associated with the managed property “mvTo” as illustrated here:

Available control types:

Text

Dropdown

For more information and samples refer to Using the DropDown control in search panels

DateRange

Or to include time.

The ShowTime parameter is only available in MacroView DMF and Message 8.8.74 and later.

When ShowTime is not present or is set to 0 the date range specified is assumed to be 12:00 AM on the date in the top control and 12:00 AM on the day following the date on the bottom control.

Checkbox

TaxonomySearch or TaxonomyPicker

For more information and samples refer to Search Panel controls: Enterprise Keyword and Taxonomy Search

EnterpriseKeyword (DMF and Message 8.7 or later)

For more information and samples refer to Search Panel controls: Enterprise Keyword and Taxonomy Search

Hidden

By setting Type="Hidden" in a search mask control you can hide the control from users.

In the above example, a hidden control is used to define Email messages as files that have a file extension of ‘msg’.

You might also use a hidden control type as another way of limiting the results by defining a Value for it to filter results on.

Other optional control parameters include:

MatchType

SearchPredicate

AdvancedBooleanSearch

By setting Type="AdvancedBooleanSearch" in a search mask control you can submit any KQL directly.

For more information refer to Using the "Advanced" control in search masks to submit KQL directly

Defining the columns for the search results

The fields displayed in the search results pane are defined between the <SelectFields> and </SelectFields> tags. Each field is defined by its managed property name and the display name for the column.

</SelectFields>

For custom date/time columns such as Created in the example above you should also add the Type="DateTime" parameter to ensure the date is displayed in the format defined by your client settings. If this is not added the date will display in UTC time format.

Sorting results using Number type fields

Displaying a column that is of a number type

A number type is required to be defined otherwise the column will be treated like a string value when sorting.

Defining refiners

The fields displayed as search refiners are defined between the <Refiners> and </Refiners> tags. Each refiner is defined by its managed property name and the display name for the refiner.

</Refiners>

Note: The refiner name tag is case sensitive and the Author property is not refinable by default. The Author property must be configured in the search service application and a full crawl completed before it can be used.

[Me] placeholder in search panels for Author columns

From MacroView DMF/Message 8.9.349 and later for SharePoint online and lite servers.

Search panels can be configured to return documents that use any managed property defined person/group field that are 'checked out to me' or 'my documents' using the [Me] placeholder.

"mvCheckoutUser" or "mvMyDocument" can be substituted for values such as mvDocumentAuthor, mvMatterManagedBy, mvProjectManagedBy or mvManagedBy.

Standard

<Control Name="mvCheckoutUser" Type="Checkbox" DisplayName="Checked out to me" Value="[Me]"/>

New

<Control Name="mvDocumentAuthor" Type="Checkbox" DisplayName="Checked out to me" Value="[Me]"/>

Articles in this section

Understanding the search mask definition

Defining the panel name and scope

Panel name

Search scope

Using a search scope

Using a result source

Using term sets defined at the site collection

Where clause

Duplicate Trimming

Word Stemming

Defining the panel controls

Defining the columns for the search results

Sorting results using Number type fields

Defining refiners

[Me] placeholder in search panels for Author columns

<Control Name="mvCheckoutUser" Type="Checkbox" DisplayName="Checked out to me" Value="[Me]"/>

<Control Name="mvDocumentAuthor" Type="Checkbox" DisplayName="Checked out to me" Value="[Me]"/>

Related Articles:

Comments

Articles in this section

Understanding the search mask definition

Defining the panel name and scope

Panel name

Search scope

Using a search scope

Using a result source

Using term sets defined at the site collection

Where clause

Duplicate Trimming

Word Stemming

Defining the panel controls

Defining the columns for the search results

Sorting results using Number type fields

Defining refiners

[Me] placeholder in search panels for Author columns

<Control Name="mvCheckoutUser" Type="Checkbox" DisplayName="Checked out to me" Value="[Me]"/>

<Control Name="mvDocumentAuthor" Type="Checkbox" DisplayName="Checked out to me" Value="[Me]"/>

Related Articles:

Related articles