Search as you type web part for SharePoint List Columns

Transcription

1 Search as you type web part for SharePoint List Columns Enterprise Edition MetaDataSys Inc Web: January 2011 Page 1

2 Contents Description of the Web Part... 3 Installation Instructions... 4 Configuration of the web part... 5 Trial License... 7 Licensed Version... 8 Page 2

3 Description of the Web Part The Search as you type web part for SharePoint List Columns can be enabled on any SharePoint List or Document Library. This web part has the following functionality Automatically provides a text box column (for columns that are of type Text ) just below the list headers for users to enter search text. When the user starts typing in the text box for a given column, results are displayed based on the text entered Configuration Parameters: The web part has the following 2 properties that can be configured List Name View Name The web part can be used in Windows SharePoint Services 3.0, MOSS 2007 and SharePoint 2010 environments. Page 3

4 Installation Instructions Wsp Installation: 1. Extract Metadatasyssaytwebpart.wsp from the zip file Metadatasyssaytwepartpackage.zip for the licensed version and Metadatasyssaytwepartpackagetrialversion.zip for trial version. 2. Run the following stsadm commands to add and deploy the solution package. Add the Solution: The zip file includes 2 files 1. install.bat (This can be used to add the package in SharePoint 2007 environment) 2. install2010.bat ( This can be used to add the package in SharePoint 2010 environment) Depending on your environment, you can run the above batch files to add the Solution package. These batch files have the following command. stsadm -o addsolution -filename Metadatasyssaytwebpart.wsp Deploy the Solution: stsadm -o deploysolution -name Metadatasyssaytwebpart.wsp -immediate -allowgacdeployment - url -force The package can be deployed using SharePoint Central Admin as well. 3. Activate the Search as you type web part for SharePoint List Columns from Site Collection features Administration. This will add the web part to the web part gallery Page 4

5 Configuration of the web part You will see the web part as below while you add the web part to your page. After adding the web part, click on Edit Web Part and set the properties. Select a List and View as in the below screenshot, give the web part a Title and click on Apply, ok and then exit the page. Page 5

6 After that, you should see the web part display the details from the list as below. Page 6

7 Trial License The Trial version does not expire. The trial version will display only 2 columns and these can be searchable. Also, you will notice a message This search is powered by Metadatasys inc's List view search Web part for trial version. License key is not needed for using the Trial version. The trial version can be converted to licensed version by purchasing a license from our reseller and activating the license key as described in the next section. Page 7

8 Licensed Version The licensed version does not have any restrictions. After purchase of a licensed version from our reseller you will receive a license key. A valid license key is needed for every SharePoint Web Front End server. To activate the license, please run MdatasysActivateKey.exe on your SharePoint Front End server.this executable is part of the zip file that is sent to you when you purchase the license. As displayed in the above screenshot, please enter the License Key that is sent to you and click on the Activate button. The server name field is automatically populated. The server name is the name of the SharePoint Front End Server. Click on the Activate button to activate the license. During the activation process, the License key and Server Name are transmitted to our server for validation and activation purposes. Upon successful validation, a box will be displayed that will have the web.config entry (Key and value that should be part of the <AppSettings> node. Below is an example of the information that will be displayed on successful activation. <add key="metadatsysspsaytwp" value="nydaf1ifcqcm1c+baz9jukw28vv8r0vy5xyt9rex8v9gja4hzhptcgdjalki/cgi" /> Page 8

9 Sometimes, due to network or other communication issues, activation may not succeed. In such situation, please the following information to 1. License Key 2. Server Name Once we get this information, we will validate your purchase and send you the web.config entry that you can add to the Appsettings section. After the web.config entry is added, the web part will have full functionality. Page 9