Installation & User Guide

Transcription

1 SharePoint List Filter Plus Web Part Installation & User Guide

2 Copyright KWizCom Corporation. All rights reserved. Company Headquarters P.O. Box #38514 North York, Ontario M2K 2Y5 Canada Web site: Sales Telephone:

3 Table of Contents Table of Contents... 3 Introduction... 4 Overview 5 Key Features & Benefits 7 Installation... 7 Software prerequisites 8 Installation Procedure 8 Post Installation 9 Component Activation Administrator Guide Introduction 12 Web Part Properties & Configuration Options 13 Filter Advanced Filter Options Advanced Display Options Errors FAQ I added the web part to my site but I can't modify the web part's properties. What is wrong? 21 I configured everything I need and clicked "OK" but nothing happened. How do I fix this? 21 Do I have to install anything on my company's client-pcs? 21 Version Release Notes Version History 22 This Version's Known Issues/Limitations 23 Technical Support

4 Introduction KWizCom's SharePoint List Filter Plus web part enables you to filter SharePoint lists with maximum ease. SharePoint List Filter web part is compatible with both MOSS 2007 and WSS 3.0. This document provides all the information needed to install, evaluate and deploy this KWizCom product: Product overview Installation guide Component activation Administrator guide FAQ Version release notes 4

5 Overview Filter and Search for information in your SharePoint lists now easier than ever with SharePoint List Filter Plus web part! SharePoint List Filter web part enables you to create custom filter forms, composed from multi-select drop-down lists and search text boxes. Connect your customized form to multiple lists and libraries at your convenience! Select multiple values in several filtering controls without going through tedious page post-backs! Support cascading behavior When you select a value from one of the filtering drop-down controls it automatically filters all the other drop-down controls. In the following screenshot after choosing "Brian Cox" in the 1 st dropdown, the second drop-down (Status) will show only the statuses of tasks assigned to Brian Cox. 5

6 Support for WSS Unlike SharePoint out-of-the-box filter web parts (which are available only in MOSS 2007), KWizCom's SharePoint List Filter Plus web part is also available for WSS users! Cross-browser support KWizCom's multiple drop-down filter web part is compatible with Microsoft Internet Explorer, Mozilla Firefox and Google Chrome. 6

7 Key Features & Benefits Feature KWizCom SharePoint Multiple Drop-Down Filter SharePoint List Filter Supports MOSS 2007 / WSS 3.0 Both MOSS and WSS MOSS 2007 only Apply multiple filters Fully customizable interface via CSS Customizable captions Enable searching by asterisk (*), to search for part of a string Supports calculated fields Enables multiple selections in drop downs Comes with various skins Supports cascading behavior Saves the user's last filter settings Can populate filter parameters from a query string (URL) Multi-lingual by design customize to the language of your choice with ease! Cross browser - IE, Firefox and Google Chrome 7

8 Installation Software prerequisites Server Requirements 1. Microsoft Windows SharePoint Services 3.0 or 2. Microsoft Office SharePoint Server 2007 (MOSS 2007) Client PC Requirements 1. Microsoft Windows XP (SP2) / Windows Vista 2. Microsoft Internet Explorer 6 or Microsoft Internet Explorer 7 or Mozilla Firefox v Installation Procedure 1. Log in as local admin to KWizCom's SharePoint server. 2. Unzip the KWizCom SharePoint Multiple Drop-Down Filter Web Part zip file on your SharePoint server. 3. Double-click the.msi file in order to begin the web installation. When the installation process is complete it will automatically recycle all application pools. 8

9 Post Installation 1. After completing the installation, you will see a new KWizCom entry in Windows Start -> All Programs -> KWizCom containing the following programs: About SharePoint Multiple Drop-Down Filter Web Part Displays general information about the component. Activate SharePoint Multiple Drop-Down Filter Web Part This utility enables you (the SharePoint Administrator) to activate the downloaded evaluation version. SharePoint Multiple Drop-Down Filter Web Part User Guide Link to your user-guide (.PDF). 2. When you browse your SharePoint Portal / Windows SharePoint services site, a new Multiple Drop-Down Filter Web Part will be available for you under "virtual Server Gallery". 9

10 Component Activation KWizCom components are available for evaluation prior to purchase. This enables you to try our components and verify that they indeed meet your needs. The evaluation version for each KWizCom component contains all the features of the component's production version. The only difference between the versions is that the evaluation will time out after one month. Once you decide to order a KWizCom component, follow the steps detailed below: 1. Order the component on the KWizCom website 2. Send us the installed evaluation version's Product Code (you will see the product code on the "About" product page: Product Code Note: use the Activation Request web form, on the KWizCom web site to send us your product code! 3. Get the component activation key this key will be sent to you by once your order is processed. 10

11 4. Activate your installed evaluation version - click Start -> All Programs -> KWizCom -> SharePoint Multiple Drop-Down Web Part -> Activate SharePoint Multiple Drop- Down Filter Web Part 11

12 Administrator Guide Introduction When you browse your SharePoint Portal / Windows SharePoint services site, a new Multiple Drop-Down Filter Web Part will appear under "Virtual Server Gallery": The following section reviews Multiple Drop-Down Filter Web Part's properties and configuration options. 12

13 Web Part Properties & Configuration Options Before starting to configure the SharePoint List Filter Plus web part, you need to connect it to the standard SharePoint List which you want to filter: 1. Click "Modify Shared Web Part" to modify SharePoint List Filter Plus web part properties: 2. When you are in Edit Mode, Go to the "edit" menu -> Connections -> Provide Filter To, and choose the list you wish to filter using the Multiple Drop-Down Filter Web Part: After connecting the web part to the required list web part, you can start configuring the web part's properties, which are grouped in 4 sections: 13

14 1. Filter 2. Advanced Filter Options 3. Advanced Display options 4. Errors Each section is detailed below. 14

15 Filter This is where you define the source columns that will be used to display the filtering drop-down controls, textboxes and for every source column the target field that will be filtered. You can: Use the list displayed in the connected web part as your source list when checking this option, you'll be able to make one of the connected list web parts become the data source for the drop-down controls in this filter web part. 15

16 Select connected web part choose the web part that you wish to be the data source for a drop-down control in your filter. Source Site URL choose the site you wish to connect to Source list - choose the list or library you want to connect Select a view select the list view to apply to the connected SharePoint list. Select a Source Field values from this field will be the values that define how the the web part filters. Select a Target Field this specifies which field in the standard SharePoint list should be filtered. Define a control caption create the caption of your choice to be displayed next to the filtering drop-down box / textbox. After you define a source field and target field pair, click the Add button in order to add this definition to the Bound Fields list: 16

17 Advanced Filter Options Use this section to setup advanced Web Part options: Always remember previous filter checking this checkbox will make user's filter selection 'persistent' - the web part will "remember' the filter settings even if the user closes the browser. Control Width Define the width of the web part. Empty Row Caption Define the caption for the empty row option that will be displayed in the drop-down box. 17

18 When no filtering value is selected, show all filtered list items- display all of the list items when the filter is empty Override original view's filter checking this checkbox will make the selected user's filter override view settings of the filtered list. Controls in row Define the number of drop-down filter controls to be displayed in a single row. Display apply filter and clear filter buttons for the entire filter the apply filter and clear filter buttons will be available. "Apply Filter" button caption - Define the caption for the Apply Filter that will be displayed in the drop-down box. "Clear Filter" button caption - Define the caption for the Clear Filter option that will be displayed in the drop-down box. Show Clear Filter button for each drop down control add an X next to each drop down to enables users to clear the filter value Display a Select All option in every drop down control adds a Select All option that enables you to choose all checkboxes at once Select All caption - Define the caption for the Select All that will be displayed in the drop-down box. Display OK and Cancel buttons in every drop - down control adds OK and Cancel buttons to enable the users to apply or cancel their choices. 18

19 OK button caption - Define the caption for the OK that will be displayed in the drop-down box. Cancel button caption - Define the caption for the Cancel buttons that will be displayed in the drop-down box. 19

20 Advanced Display Options In this section you can customize the Multiple Drop-Down Web Part display using your own CSS file. Insert the file's location in the top text box and define the names of the classes to use for field captions and for drop-down boxes. You can also customize the entire web part layout by updating the web part's user control (Template url), using Visual Studio. Errors In this section you can choose to show or hide different errors from the users. 20

21 FAQ I added the web part to my site but I can't modify the web part's properties. What is wrong? Before starting to configure the SharePoint List Filter Plus web part, you need to connect it to the standard SharePoint List that you want to filter. After connecting the web part to your desired list, you can start configuring the web part's properties. Please view the "Administrator Guide" to learn how to connect a standard SharePoint list to the Multiple Drop-Down Filter Web Part. I configured everything I need and clicked "OK" but nothing happened. How do I fix this? After configuring the desired filtering options in the Data Source section, click the "Add" button this will integrate your settings into the SharePoint List Filter Plus web part. You can see that your configurations have been stored by verifying that they are listed in the "Bound Fields" table. Do I have to install anything on my company's client-pcs? No. The KWizCom SharePoint Multiple Drop-Down Filter Web Part is a server installation. Once installed on the server, it can be used from any client-pc connected to it. 21

22 Version Release Notes Primary Software Version Base version Release date Module n/a May Sub-Modules Version n/a Version History CR # Description Version , May Fixed Bug: Filter for Date Time field type does not work 86 Fixed Bug: Japanese control titles issue Version , Feb Fixed Bug: Cannot show data in filter if the field is named "Author" 80 Fixed Bug: Error during installation 82 Allow users to override the original selected filter's default view Version , Oct Change "Drop-down list caption" to "Control caption" Fixed bug: When several web parts are connected to the same filter they always show the same view Add new property Always remember previous filter to web part properties which will make the user's selected filter 'persistent' (even if the Browser is closed). Enable filter to read filter parameters from query string and apply the filter. 67 Use the predefined view filter for filtering connected web part 68 New property Select data source from connected web parts Fixed bug: Selecting a new field for the filter without a caption inserts the previous field's caption Fixed bug: When using web part as data source the "control caption" field is disabled Fixed bug: sometimes checking "Display "Apply Filter" and "Clear Filter" buttons for the entire filter" doesn't display these buttons 22

23 Version , July Fixed bug: Wrong drop-down sorting when containing numbers/dates. 54 Support Textbox controls 55 Apply the same sort ordering for drop-downs which have data for choice field 56 Support Data Form web part filtering 58 Change "Use Text Box For Filter" caption and control 60 When no filtering value is selected "show all filtered list's items" should be selected by default Version , March Fixed bug: The tool part should have a "help" icon with the URL tokens instructions 38 Support Firefox 43 Enable entering search string including "*" to filter text 26 Fixed bug: Support calculated fields 20 Fixed bug: Tool Pane is too narrow. 27 Fixed bug: support group by view 39 Fixed bug: Enable spaces in field captions 40 Support multiple selections in drop downs Add apply filter and clear filter buttons to apply or reset the filter OK and Cancel buttons will apply or cancel your selections and prevent multiple post backs. 48 select all option 52 Support different skin designs 34 Support cascading behavior 50 Fixed bug: long lines break in drop downs 45 Support paging This Version's Known Issues/Limitations CR # n/a Description none 23

24 Technical Support You can obtain technical support using any of the following methods: The KWizCom Web site The KWizCom website at valuable information, including: contains the updated, Answers to frequently asked questions (FAQ's) about KWizCom products usability and technical questions. Product updates, which provide you with bug fixes and new features. The Web Form For technical support through the Internet, please fill in our support web form on our web site KWizCom's global network of experts is always standing by, waiting to provide a rapid response for each customer query. Our goal is to provide nothing less than outstanding service. 24