X1 Microsoft SharePoint Connector - Release Notes
Microsoft SharePoint® Plugin for the X1 Client
Installation and Configuration Release Notes
This release notes documents the steps for installing, configuring, and working with the Microsoft SharePoint Plugin for the X1 Client. The SharePoint Plugin will enable the X1 Client to query SharePoint server using SharePoint Query web service API and Keyword Query syntax. These queries can be federated with local and remote searches to provide a unified query interface. The intended audience for this release note is administrators who are customizing the X1 Client for distribution in an enterprise environment. For complete documentation on standard X1 Client features, please refer to the X1 Client Deployment Guide.
1. Before Installing the Plugin
Before installing this plugin, the prerequisites described in this section must be satisfied.
X1 Professional Client, version 6.x or later, installed and registered.
Microsoft Office SharePoint Server 2007(MOSS), installed and accessible over the network.
o Also works with Microsoft Search Server 2008 Express
2. Installing the Plugin
Confirm that you have satisfied all prerequisite requirements before beginning plugin installation.
To install this plugin, complete the following steps. 1. In the X1 Client, click the Tools menu.
2. Click Options.
The Options dialog box opens. 3. Click Plugin Manager in the Options tree control. To install a new plugin, click the Install New Plugin button. The Open dialog box appears.
4. In the Open dialog box, navigate to the location where the plugin is stored on your computer. The plugin is named SharepointPlugin.x1i.
5. After you locate the plugin, click Open.
A message appears asking you if it is OK to install the plugin. 6. Click OK.
The plugin is installed and appears in the plugin list of the Plugin Manager.
7. From the Plugin Manager list in the Enable column, click to select the enable option for the plugin.
Page 1 of 4 X1 Microsoft SharePoint Connector - Release Notes
8. Installation of the plugin is complete. Leave the Options dialog box open and continue to the next section to set up the plugin remote sources. 3. Setting up remote plugin datasources
After plugin options are configured, you will need to configure remote sources the plugin connects to. Note: If the remote source requires a username and password, set up an account for yourself on the remote source before starting this procedure. You will supply your own username and password temporarily in this procedure so the X1 Client can verify the connection AND uncheck the “save username/password” option. Users will have to supply their own username and password to access the remote datasource when the X1 Client is deployed. 1. In the X1 Client, click the Tools menu and select Select Sources.
The Select Sources dialog box opens.
2. In the Select Source dialog box, click Add. The Add Source dialog box opens.
3. In the Add Source dialog box, from the Choose Connection Type dropdown list select SharePointPlugin.
4. In the Add Source dialog box for the Location field, type the URL of the web address of SharePoint Server Site or Sub-site. Example: http://sharepointsite.x1.com/subsite.
5. In the Add Source window, enter your Active Directory domain credentials for the SharePoint Server in the Username and Password fields. The username value must be preceded by the domain of the SharePoint server and a slash, then your username value. Uncheck the “save username/password” option.
Example of a correctly formatted username with the domain included:
Domain\username If you leave the username\password fields blank the plugin will attempt to use you logon credentials (using Windows Integrated Authentication) for authenticating against SharePoint server.
6. In the Add Source Window enter a descriptive name for the Source Name field. Users will see this name, so you may want to indicate content with the name for them, such as “SharePoint Search”.
7. Select the “Select Site/List/Document Library” optionto enable a dialog to select a single SharePoint sub-site, list, or document library.
8. In the Add Source dialog box for the Results per page field, enter a value for the default number of results. The recommended default value for the plugin is 50 results.
9. Click OK to close the Add Source dialog box.
4. Security When this plugin is installed in the X1 Client, the following security changes occur:
Security for this plugin accessing SharePoint Server is handled by the WinINet API that can handle SharePoint Server Windows Integrated Authentication (NTLM) 5. Query Syntax Changes and Limitations
Searches from the main search box go against the whole SharePoint server content. Searches from particular fields are composed as property filters
Page 2 of 4 X1 Microsoft SharePoint Connector - Release Notes
The following table lists the search term syntax supported for use during search queries with the plugin.
Search Search Results Conformance Term
- Empty field search. Supported
= Non-empty field search Not Supported
the= The exact word the in any column. Supported
-the No occurrence of any word starting with Not Supported the in any column.
NOT the Same as -the. NOT must be all caps. Not Supported
-the= No occurrence of the exact word starting Supported (only if ‘the’ is the only word in with the in any column. particular column
NOT the= Same as -the=. Supported (only if ‘the’ is the only word in particular column
a AND b A word starting with a and a word Supported starting with b in the same column. AND must be all caps.
a b Same as a AND b. Supported
a & b Same as a AND b. Supported
a OR b A word starting with a or a word starting Supported with b in the same column OR must be all caps.
a | b Same as a OR b Supported
"the big d" The prefix phrase, the big d. This will Supported match the big dog, the big date, etc.
"the big d"= The exact phrase, the big d. This will not Supported match the big dog, the big date, only the big d (where d is a complete word).
(a | b) & c Performs a | b first, then AND with c Supported
a | (b & c) Performs b & c first, then OR with a. Supported
6. Preview Functionality Changes
This plugin supports browser-based preview of any list items and native app based preview for any documents that a user has permission to access with the User ID and password supplied at configuration. If credentials were not supplied, or credentials were incorrect, the login dialog will appear when the user tries to preview an item to give the user another opportunity to supply the correct credentials. 7.Post Search Action Changes
This plugin supports all of the basic Post Search actions, except for Add to Zip when source is configured to search SharePoint list. The Add to Zip action will be enabled and will work for documents when a source is configured to search site or document library. The plugin also defines set of custom actions which will also be
Page 3 of 4 X1 Microsoft SharePoint Connector - Release Notes
enabled and will work for documents when a source is configured to search site or document library. These are: Check In, Check Out, Delete, and Go To Folder. 8. Modifying the Default Fields
This plugin supports modifying the default field schemas. There is a default schema defined (sitemasterschema.xml)
To modify the schema for new sources open the respective xml file located in c:\Program Files\X1\extensions\SharePointPlugin\bin\. Field schemas for existing sources will not be changed. 9. Other Properties/Limitations
Sorting - Sorting is supported for a single field only. Multiple field sorting is not supported.
Get All –The Get All navigation button is not supported for search results returned by this plugin. Maximum result count –An Enterprise Search engine collection is often limited at the collection level on the number of results that can be returned for a query. The X1 Client will not be able to return more than the result limit.
Rank- Queries on a Rank field are not supported, it always yields zero results. Date Searches –Searches against SharePoint will ignore date columns. Once the SharePoint results load in the X1 results list, you may filter the results via the date column filters. Total Results Available is actually just an estimate and not the exact number of matches.
Path column / property –Queries on Path field are all or nothing, They will yield results on a complete string entered (won't get results for part of the string).
Searching image files, zip files and other non default file types - In order to be able to search non-default file types in Microsoft SharePoint, such as image files or zip files, add each file type under 'Manage File Types' and restart the search service. Check an iFilter is installed for these non-default file types.
Page 4 of 4