Installation & User Guide

Size: px

Start display at page:

Download "Installation & User Guide"

Camron Hardy
6 years ago
Views:

1 SharePoint List Aggregator Installation & User Guide

3 Table of Contents Introduction... 4 Overview 5 Support grouping and sorting 8 Drag & drop columns functionality 9 Ability to use views 10 Different skins 11 Export to CSV and PDF 11 Installation Software prerequisites 15 Installation Procedure 15 Post Installation 16 Component Localization Resource File Editor utility structure 17 Translating a KWizCom component 18 Use the component in your preferred language 19 Component Activation Administrator Guide Introduction 22 Web Part Properties & Configuration Options 23 Aggregation Source Aggregation Views Definitions Look & Feel FAQ What does the List Aggregator do? 35 What type of SharePoint installation is needed for this web part to work? 35 Do I have to install anything on my company's client-pcs? 35 Version Release Notes Version History 36 Technical Support

4 Introduction KWizCom SharePoint List Aggregator enables you to view and use SharePoint list and document libraries from the entire site collection. You can view all site collection s lists from the same type or a specific one. KWizCom SharePoint List Aggregator Supports MOSS 2007 / 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

Overview Easily aggregate data from a variety of lists and libraries, into a single clear, great looking consolidated view! Available both in MOSS 2007 and WSS 3.

5 Overview Easily aggregate data from a variety of lists and libraries, into a single clear, great looking consolidated view! Available both in MOSS 2007 and WSS 3.0 True aggregation (roll-up) capabilities across SharePoint sites, Exchange Calendars, now including new great looking skins and AJAX-based inline editing capabilities! Export to Excel / PDF Easily toggle between views AJAX-based display: Sort, filter and group by columns just by Drag&Drop! 5

6 SharePoint List Aggregator is aimed to solve the following existing issues in MOSS 2007/WSS 3.0: WSS users have no means of aggregation because Content Query web part exists only on MOSS. The content query web part is very hard to use; for simple tablelike rendering you are required to edit complex xsl files. The content query web part doesn t enable in-line editing of the aggregated content. Need to export data to Excel/PDF. KWizCom SharePoint List Aggregator web part provides ultimate aggregation (roll-up) capabilities plus some great usability features that make it easy to use and deploy: 6

7 In-place list item editing With KWizCom SharePoint List Aggregator's AJAX-based inline form you can update any aggregated list item within the aggregator web part, with no additional page refresh! 7

Support grouping and sorting KWizCom SharePoint List Aggregator enables you to group number of lists from the entire site collection or a specific

8 Support grouping and sorting KWizCom SharePoint List Aggregator enables you to group number of lists from the entire site collection or a specific list from a single site. You can group the list items by site or by a list property. Sorting is available by all the list properties or by site name. 8

9 Drag & drop columns functionality When adding KWizCom SharePoint List Aggregator to your web part page in editing mode, it is possible to change the columns order by dragging & dropping list columns. 9

10 Ability to use views With KWizCom SharePoint List Aggregator you can use the available views to present to your users and users can change the current view by choosing a different view in the views drop down control. 10

11 Different skins KWizCom SharePoint List Aggregator enables you to change the web part s look and feel easily by choosing one of the various great-looking skins: variety of skins Export to CSV and PDF With KWizCom SharePoint List you can export the list items to PDF format by clicking on or to CSV format by clicking on Enable filtering You can filter your list items by all kind of filter options like: contains, stars with, equal to and etc. 11

Support Microsoft Project Server web access list types KWizCom SharePoint List Aggregator supports also the Project Web Access (PWA) list types:

12 Support Microsoft Project Server web access list types KWizCom SharePoint List Aggregator supports also the Project Web Access (PWA) list types: Deliverables, Issues and Risks: This makes the KWizCom List Aggregator the perfect tool for Enterprise Project Management (EPM), SharePoint-based solutions. 12

By using the List Aggregator web part, you can easily provide a project management dashboard that aggregates all project information from the various project workspaces.

13 By using the List Aggregator web part, you can easily provide a project management dashboard that aggregates all project information from the various project workspaces. You can roll-up information such as: High probability risks Open issues Recent deliverables The Table viewer web part Another free valuable addition that you receive with the KWizCom SharePoint List Aggregator is the KWizCom List aggregator- Table viewer, This web part allows you to use the powerful aggregator grid to show filtered data from any SharePoint list or library! A provider for this web part is KWizCom List Filter Plus version or above. 13

14 Key Features & Benefits Feature Supports MOSS 2007 / WSS 3.0 Cross browser support: Support IE, Mozilla Firefox and Google Chrome Multilingual (standard for all KWizCom components) Sleek, AJAX-based user interface, with minimum post backs. Support grouping and sorting Use standard SharePoint views to define cross-site queries for content aggregation Provide great looking skins Aggregation of various list types (libraries, tasks, announcements) Cross-site aggregation Aggregate by site/list names ( All lists that begin with ProjA ) Much more flexible than only aggregating by content types! Support more than one site/list name to aggregate by Support tokens in site names enables easy deployment as a part of site template Aggregate items from other site collection or even web application. Drag & drop columns functionality Enable editing list items in the web part itself Enable column filtering Reporting by exporting to EXCEL and PDF Support Microsoft Project Server web access list types Free addition- The Table Viewer web part Standard edition 14

15 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 7+ or Firefox Mozilla (Latest version) or Google Chrome (Latest version). 3. Optional- to use the Table Viewer web part please install the KWizCom List Filter Plus version or above. Installation Procedure 1. Log in as local admin to our SharePoint server. 2. Unzip the KWizCom SharePoint List Aggregator 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 recycle all application pools automatically. 15

16 Post Installation 1. After completion of the installation, you will see a new KWizCom entry in Windows Start -> All Programs -> KWizCom containing the following programs: About KWizCom SharePoint List Aggregator Display General Information about the component. Activate KWizCom SharePoint List Aggregator This utility enables you (the SharePoint Administrator) to activate the downloaded evaluation version. SharePoint KWizCom SharePoint List Aggregator User Guide Link to user-guide document (.PDF). SharePoint KWizCom SharePoint List Aggregator Resource Editor This utility enables you (the SharePoint Administrator) to translate the component to your local language. Please review the next sections for further details about component localization and activation. 16

Component Localization Every KWizCom component comes with localization utility called "Resource File Editor" that enables translation of the component user interface to any required language.

17 Component Localization Every KWizCom component comes with localization utility called "Resource File Editor" that enables translation of the component user interface to any required language. This section describes this utility and the translation process. Resource File Editor utility structure This utility displays the following dialog that enables the administrator to translate every displayed string (captions, menu items, user-messages) to the required target language. Here you select the target language All internal string names The captions that should be displayed in your localized language The default displayed caption for each string in English 17

18 The application displays 2 controls: "Select Culture" drop-down contains a list of target languages. Strings grid This grid contains all the strings displayed by the component. The grid includes 3 columns: a. Internal Name This column displays the internal name of each string (read only). b. Default Value The default displayed value in English (read only). c. Localized Value The translated value in the selected language. This is where you enter the required translated value. Once you finish translating all the component strings, click "Create" and a resource file will be created. This resource file will automatically be used by the component upon changing the user language on your server. For example: In an MS SharePoint-based component, you should create a site using your required SharePoint Language Pack. According to the SharePoint site language, the relevant language's resource file will be used by the component. Translating a KWizCom component 1. On your Windows task bar, select: Start->All Programs->KWizCom->SharePoint List Aggregator web part-> SharePoint List Aggregator Resource Editor 2. Select your target language on the "Select Culture" drop-down list. 3. Translate all the displayed strings in the strings grid by entering a translated value in the "Localized Value" column. 4. Click the "Create"/"Update" button in order to create/save a resource file for the selected target language. 18

19 5. If you want to create additional resource files for more target languages, simply repeat stages 2-4 for each language. 6. Close the utility by clicking the "Close" button. Use the component in your preferred language All KWizCom components use.net localization mechanism. This means that a KWizCom component will automatically use a language resource file according to the displayed application's language (this is true for all types of components). 19

Component Activation KWizCom components are available for evaluation prior to purchase. This way you can try our components and verify that they indeed meet your needs.

20 Component Activation KWizCom components are available for evaluation prior to purchase. This way you can try our components and verify that they indeed meet your needs. An evaluation version for each KWizCom component contains all features of the component's production version. The only difference is that an evaluation version is time-limited, and will operate for a period of one month. Once you decide to order a KWizCom component, you will need to follow the following steps: 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 Please use the Activation Request web form, on KWizCom web site 20

21 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. 4. Activate your installed evaluation version - click Start -> All Programs -> KWizCom -> KWizCom SharePoint List Aggregator-> KWizCom SharePoint List Aggregator 5. When you browse your SharePoint Portal/ Windows SharePoint services site, a new KWizCom SharePoint List Aggregator Web Part will be available for you under "virtual Server Gallery". 21

22 Administrator Guide Introduction When you browse your SharePoint Portal/ Windows SharePoint services site, a List Aggregator Web Part will be available for you under "virtual Server Gallery" This section reviews List Aggregator web part's properties and configuration abilities. 22

23 Web Part Properties & Configuration Options The web part's properties are grouped in 3 categories: Aggregation Source View Definitions Look & Feel In order to set these settings click on modify Web Part Settings button The following sections provide details about each category. 23

24 Aggregation Source Aggregation Scope here choose the aggregated scope from the drop down Root Site URL here insert the SharePoint site address in which you wish to view the list. After typing the address click on "Load..." List type choose the list base from the drop down 24

25 Look in sites named as- you can filter the aggregated sites by the names you insert in this field. If you do not wish to filter these items returned with a specified name, leave this field empty. Look in lists named as: you can filter the aggregated items by the names you insert in this field, you may insert more than one name. If you do not wish to filter these items returned with a specified name, leave this field empty. 25

Aggregation Views Definitions The list aggregator uses an "Aggregation Views list - standard SharePoint list that contains the queries (views) that will be used to perform the data aggregation.

26 Aggregation Views Definitions The list aggregator uses an "Aggregation Views list - standard SharePoint list that contains the queries (views) that will be used to perform the data aggregation. This means that after you plan your required aggregations, you should create a list that will include the columns and the views that will be used to perform the actual cross-site queries (aggregations). Views List Web Site URL insert here the SharePoint site address where the aggregation list is located. After typing the address click on "Load..." 26

27 Aggregation views list Choose the exact list that will be used for the aggregation. Default view here you choose the default view to be presented in the web part Show views picker check this check box if you wish to show the views picker to the users. Look & Feel Enable AJAX Allow better experience with minimum page refreshing 27

28 Enable column recorder Allow better experience by letting the user recorder columns for his connivance Enable drag & drop to groups enable drag & drop of list columns Choose skin here you choose the color scheme to be presented in the web part Allow editing enable editing of list items Show export options enable users to export the items to PDF and CSV Allow filtering enable filtering of the list items in the web part. Expand groups by default if you check this checkbox by default when you use grouping the groups will be expanded. Group items by site name - when checking this checkbox the list items will be grouped by site name Group items by name - when checking this checkbox the items will be grouped by list name 28

29 Specify items per page type the number of items you wish to be presented. Choose pager control mode choose pager control mode Choose pager control position choose the pager control position 29

Table viewer Properties & Configuration Options First- to use this web part please see the administration guide of the KWizCom SharePoint List Filter Plus, after configuring the List filter plus with

30 Table viewer Properties & Configuration Options First- to use this web part please see the administration guide of the KWizCom SharePoint List Filter Plus, after configuring the List filter plus with the desired filter fields you must connect the List Filter to provide data to the Table Viewer as follows: In Edit mode, click edit on the List Filter Plus and choose Connections< Set DataTable To<KWizCom List Aggregator- Table Viewer: (Note that if you changed the display name of the Tree Viewer, the new name will appear under Set DataTable To) The web part's Configuration can be found under the KWizCom List Filter settings, in order to set the Table Provider Query Settings click on modify Web Part Settings button 30

31 Query Root Site URL- insert here the SharePoint site address where the aggregation list is located. After typing the address click on "Load..." Query Scope- choose the scope from which to want to choose the list template List Type- choose the list type to provide the data for the Table Viewer 31

32 Field Internal Name- insert the internal name of the field which data will be displayed in the Table Viewer (You can check the internal name by clicking on the field name in a list and checking how it appears in the URL) Field Caption- insert the name of the filed as it should appear in the Table Viewer Field Format- choose the format of the field between text, Date/Time and Boolean Display Field Settings- after filling the last 3 field settings make sure you click "Add" (Check that your field appears correctly in the field list, in case you want to delete or modify it you can click "Edit" or "Delete") Open Documents In Library- check this checkbox if your provider is to a library (in which case by default clicking on the name of the document would bring you to the view item form), to open the document itself Open Item Field URL- for list items, if you wish to open another URL instead of the default, based on field names, insert the field name (you may insert several fields and separate them with "/") After configuring the Table Viewer settings under the List Filter Plus you may want to change Look And Feel settings of the Table Viewer web part- which appear under the List Aggregator- Table Viewer settings click on modify Web Part Settings button 32

33 These settings are equivalent to the Look and Feel settings of the List aggregator web part with a few additions: Show item columns- add a view link to the item to view it from the Table Viewer Allow deleting- add a delete button to the items displayed by the Table Viewer 33

Table Provider Web Part Example You may find an example for using the Table Viewer web part, to add the exemplary web part follow these simple steps: 1.

34 Table Provider Web Part Example You may find an example for using the Table Viewer web part, to add the exemplary web part follow these simple steps: 1. Log on to the Top level site as the site collection administrator 2. Click Site Actions<Site Settings<Modify All Site Settings 3. Under Galleries open Web Parts 4. Click New 5. Find the KWizCom.SharePoint.WebParts.ListAggregator.TableProviderWebPar t_example and check the checkbox next to it: 6. Click Populate Gallery and you're done! Now the exemplary web part is available to be added and viewed from any site in the site collection. Note that source code for the Table Viewer example web part is available for you as well! To receive it please contact 34

35 FAQ What does the List Aggregator do? KWizCom List Aggregator web part enables you to run cross-site queries, and display the result in a single consolidated view. This enables you to gather information from multiple sites and created functional views such as: "Open issues from all project sites", "All active announcements", "Latest press-releases from all sub sites", "Most rated blog posts of the week" etc. What type of SharePoint installation is needed for this web part to work? The KWizCom List aggregator works both on MOSS 2007 and WSS 3.0. 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. What do I need the Table Viewer For? KWizCom List Aggregator- Table Viewer web part enables you to display data provided by an advanced filter, using the grid and the display options of the KWizCom List Aggregator. 35

36 Version Release Notes Primary Software Version Base version Release date Sep Sub-Modules Module Version n/a n/a Version History CR # Description Version , August Support accessibility standard (WCAG) 81 Enable aggregating more than 1000 lists Fixed Bug: JavaScrtipt Error when aggregator has field with presence 86 icons 89 Added Table Viewer web part- supports incoming connections Version , February Support Project Server web access lists 73 Improve performance when aggregating more than 100,000 items Version , November Fixed Bug: Right to left layout problems 42 Fixed Bug: export does not get image/url fields 43 Enable to specify more than 1 list / web name for filter 44 Fixed Bug: error with folders in aggregator 45 Fixed Bug: error using discussion lists 54 Fixed Bug: changes are not applied after refresh 55 Fixed Bug: export to PDF renders irrelevant columns 58 Fixed Bug: View doesn t render sub folders 60 Fixed Bug: "modify WP Settings" doesn t work in Firefox. Version ,?? Fixed bug: export buttons show when there are no items 35 Fixed bug: View with URL or image field does not work 36 Fixed bug: Filter by list/web name does not save value 37 Fixed bug: Properties page does not work (js error) 38 Fixed bug: Filter by list or site name does not retain value after sort 36

37 Fixed bug: Using a URL or Image fields in the view definitions displays 39 empty data source message 41 Enable export to PDF Version , June Fixed bug: The Aggregator displays deleted items 5 Fixed bug: My Tasks view returns no tasks 7 Support Firefox 8 Fixed bug: Changing views makes the 'Edit" link disappear 9 Fixed bug: "Enable Edit" doesn't work in Ajax mode 12 Fixed bug: problem to sort by some of the columns 13 filtering supported 14 Fixed bug: Tool pane parameter rename 18 Fixed bug: the drop down list items are not sorted properly 28 Fixed bug: Collapse doesn't work 37

38 Technical Support You can obtain technical support using any of the following methods: The KWizCom Web site The KWizCom website at contains the most updated valuable information, including: Answers to frequently asked questions (FAQ's) about our 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 38