FAQ: MacroView DMF and MacroView Message search panels

Topics

 

What is MacroView DMF Search?

MacroView DMF Search allows you to search a SharePoint environment associated with MacroView DMF or MacroView Message for documents and emails based on a set of predefined search fields. 

MacroView DMF and Message ship with two default search panels: Email Search and Keyword Search. They are configured to search based on the terms pictured below. 

 365SearchMasks.png

 

Both search panels work with a standard set of MacroView columns that are mapped to associated managed properties in search.

Note: Managed properties must be defined and mapped correctly for the search panels to work. To find out more, read an Overview of crawled and managed properties in SharePoint Server 2013 at Microsoft TechNet.

If you are using SharePoint Server (on-premises), the crawled properties and managed properties needed for Email Search and Keyword Search will be mapped automatically after enabling MacroView DMF Search on Web Application Features and running a full site crawl (see MacroView DMF Installation and Configuration Guide: Section 3.6).

If you are using SharePoint Online (Office 365), the crawled properties and managed properties needed for Email Search and Keyword Search must be mapped manually. Refer to Search configuration of SharePoint Online for a detailed walkthrough.

Back to top ↑

 

Can I create custom search panels?

Yes! You can add new controls to an existing search panel, or define additional new search panels by editing the Search Mask XML definition file (note: search masks use managed properties as their source). MacroView recommends creating new search panels rather than editing the ones provided since you can create search panels that reflect the metadata structure and requirements of your organisation.

Though the default search panels should not be edited, these panels can be used as examples for creating new tailored-search panels for your organisation.

To find out how to create your own custom search panels, read Defining custom search panels for DMF and Message.

For more information regarding how managed properties work with MacroView Search powered by SharePoint, refer to Defining managed properties for search panels.

Back to top ↑

 

Where are the Search Mask XML definition files located?

SharePoint Server (on-premises)

MacroView DMF search panels for SharePoint Server (on-premises) can be found on your server at the following location:

C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\XX\TEMPLATE\FEATURES\MacroViewDMFSearch\SearchMasks.xml

The Email Search and Keyword Search panels are available in MacroView DMF if the MacroView DMF Search feature is active on the content web-application.

 

SharePoint Online (Office 365) or Client-Side Only Mode

When using MacroView DMF with SharePoint Online (Office 365) or against an on-premises server using Client-Side Only mode, the search panel definition can be found at the following location on the client machine:

C:\Users\<USERNAME>\AppData\Roaming\MacroView DMF\Store\O365Mask.xml

If the O365Masks.xml file is invalid or not present, MacroView DMF will continue to provide the default set of search masks, alternatively you can download a new copy of the file from the MacroView DMF or MacroView Message downloads page.

Back to top ↑

 

How do I get started creating a custom search panel? 

There are two steps to getting your custom search panel up and running:

  1. Construct your own search panel by building a Search Mask XML definition. For everything you need to know about building your own Search Mask XML definition including how to define the name, source, controls and more, refer to Defining custom search panels for DMF and Message.
  2. Share your search mask with SharePoint by:
    • (On-premises) Uploading it to your SharePoint Server, or
    • (Online/Office 365 only) Linking the Search Mask XML definition with MacroView DMF

MacroView consultants are experts in SharePoint document management and can assist you in customising your search based on your organisation's unique requirements.

Back to top ↑

 

How do I upload and install a custom search panel?

SharePoint Server (on-premises)

Note: To proceed with this section you will need to email MacroView Solutions and request access to the DMF Search Mask Manager (dmf.searchmasks.exe). This tool is used to upload and install your custom Search Mask XML definition to your SharePoint Server (on-premises).

Before making any changes to your search panels, you will need to deactivate the MacroView DMF Search Web Application Feature.

To do this, you will need to:

  • Have Farm Administrator permission level on your SharePoint server.
  • In SharePoint Central Administration, navigate to Application Management and click Manage web applications.
  • On this page select your SharePoint web application and click on Manage Features in the ribbon.
  • Scroll to find MacroView DMF Search and click the Deactivate button.

 

To install a search panel:

  • Find your Search Mask XML definition(s) and move the file(s) into the same folder that contains the DMF Search Mask Manager.
  • Execute the following command in the SharePoint Management Shell:

dmf.searchmasks.exe YOURSERVERURL YOURPATHTOXMLPANELSFILE

 

To delete a search panel:

  • Find your Search Mask XML definition(s) and move the file(s) into the same folder that contains the DMF Search Mask Manager.
  • Execute the following command in the SharePoint Management Shell:

dmf.searchmasks.exe -delete YOURSERVERURL PANELNAME

 

Note: You will need to re-activate the MacroView DMF Search feature on the correct web application for the changes to take effect.

 

SharePoint Online (Office 365) or Client-Side Only Mode

To install your custom Search Mask XML definition in MacroView DMF or Message, you simply need to host the search mask on your SharePoint Online (Office 365) tenancy, then point MacroView to that location.

First, upload your O365Mask.xml file to a location hosted on your SharePoint Online (Office 365) tenancy. Your O365Mask.xml file should contain all search masks you intend on using with MacroView DMF or Message, including the Email Search and Keyword Search provided by default and any custom ones you have created.

If you have your Search Mask XML definition(s) spread across multiple files, copy and paste them into the O365Mask.xml file before proceeding with the upload.

After the upload is complete, you'll need to point MacroView DMF or Message to the O365Mask.xml file location:

  1. Open Microsoft Outlook, select the MacroView ribbon tab and click Options.
  2. Select the Support tab on the left panel and navigate to the section titled Search Settings.
  3. Next to the Client Side Search Mask Location, click the grey box and browse to the file's location on your SharePoint Online (Office 365) tenancy.
  4. Close Microsoft Outlook, DMF Explorer (if applicable) and the MacroView DMF Local Service.
  5. Open Microsoft Outlook, click on the Search view at the bottom of the MacroView pane on the right side of the Outlook window.
  6. Click the Search Type drop down and view your newly installed search panels.

Back to top ↑

 

Related Articles:

Have more questions? Submit a request

0 Comments

Article is closed for comments.