Mindbreeze Web Parts

For Microsoft SharePoint

Introduction

This document describes the installation and configuration of the Mindbreez Web Parts, which enables the integration of the Mindbreeze Search Results and Factes in Microsoft SharePoint.

Software Requirements

System environment: All information contained in this document implicitly assumes a Microsoft Windows environment.

Supported platforms: For detailed information on supported operating systems and software, see the software product information on the Fabasoft distribution media.

Descriptions in this document are based on the following software:

• Microsoft SharePoint 2010 SP1 (x64)

Installation

Installation of the Mindbreeze Web Parts

To install the Mindbreeze Web Parts in Microsoft SharePoint perform the following steps:

1. Open the SharePoint management shell:
   “Start” > “All Programs” > “Microsoft SharePoint 2010 Products” > “SharePoint 2010 Management Shell”.
2. Execute the following command:
   stsadm -o addsolution -filename "Microsoft SharePoint Connector\Web Parts\MindbreezeWebParts.wsp"
   It is assumed that the current directory is the directory where you unpacked Microsoft SharePoint Connector.zip.

Deployment of the Mindbreeze Web Parts

To deploy the Mindbreeze Web Parts perform the following steps:

1. Open the SharePoint central administration:
   “Start” > “All Programs” > “Microsoft SharePoint 2010 Products” > “SharePoint 2010 Central Administration”.
2. Navigate to “Central Administration” > “System Settings” > “Farm Management” > “Manage farm solutions” > “mindbreezewebparts.wsp”
3. Click “mindbreezewebparts.wsp” and then click “Deploy Solution”.
   

Activation of the Mindbreeze Web Parts

To activate the Mindbreeze Web Parts perform the following steps:

1. Open Microsoft SharePoint.
2. Navigate to “Site Actions” > “Site Settings” > “Site Collection Administration” > “Site collection features” > “Fabasoft Mindbreeze Web Parts”.

Configuration

To put Mindbreeze Web Parts on a site page perform the following steps:

1. Open Microsoft SharePoint.
2. Click “Site Pages” > “Add new page”.
3. Enter a page name and click “Create”.
4. On the “Editing Tools” > “Insert” tab click “Web Part”.
5. Click the “Fabasoft Mindbreeze” category, select “Facets” or “Search Results” and then click “Add”.

Search Results Web Part

URL of Client Service

After adding a Search Results Web Part you have to configure the option “URL of Client Service” in the Fabasoft Mindbreeze group. Please enter the URL of the Fabasoft Mindbreeze Client Service to search. (You only have to set this option once, if you want to use the same Client Service for all your Web Parts on a single page. If you want to use different ones, set the property for each Web Part.)

Query

Define the search query used. If you do not set Query, the URL parameter “k” will be used. This enables the use of the Web Parts for a Search Results page of Microsoft SharePoint (see Change the Search Results page of a Site on page ).

Refinement

Refinement can be used to restrict the results with a custom restriction. If you only want to search for E-Mails you can set categoryclass:mail for a Microsoft Exchange data source.

Number of Results

Determines the number of results displayed.

Enable Paging

This option enables the “Load more results …” button below the results, if there are more results available.

Custom Template

You can define a HTML template for the search results.

Facets Web Part

URL oF Client Service

After adding a Facets Web Part you have to configure the option “URL of Client Service” in the Fabasoft Mindbreeze group. Please enter the URL of the Fabasoft Mindbreeze Client Service to search. (You only have to set this option once, if you want to use the same Client Service for all your Web Parts on a single page. If you want to use different ones, set the property for each Web Part.)

Type

Choose “Piechart” for displaying a facet as pie chart. “Text” displays a list of links for a facet.

Facets

List all facets you want to display separated by semicolons, e.g. Extension;Date. If you do not specify a value, all facets are displayed.

Query

Define the search query used. If you do not set Query, the URL parameter “k” will be used. This enables the use of the Web Parts for a Search Results page of Microsoft SharePoint (see Change the Search Results page of a Site on page ).

Refinement

Refinement can be used to restrict the results with a custom restriction. If you only want to search for E-Mails you can set categoryclass:mail for a Microsoft Exchange data source.

Custom Template

You can define a HTML template for the facets.

Change the Search Results page of a Site

To change the Search Results Page of Microsoft SharePoint perform the following steps:

1. Open Microsoft SharePoint.
2. Navigate to “Site Actions” > “Site Settings” > “Search Settings”
3. Change the setting “Site Collection Search Results Page” to the page your created and configured.