SharePoint List Aggregator

Installation & User Guide

Copyright © 2008 KWizCom Corporation. All rights reserved.

Company Headquarters KWizCom 148 Castle Rock Dr. Richmond Hill, Ontario L4C 5K5, Canada

E-mail: [email protected] Web site: http://www.KWizCom.com Sales E-mail: [email protected] Telephone: +1-905-370-0333

2 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

Table of Contents SharePoint List Aggregator .................................................................. 1 Table of Contents...................................................................................... 3 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 ............................................................................................... 14 Software prerequisites ______________________________________________ 14 Installation Procedure ______________________________________________ 14 Post Installation ____________________________________________________ 15

Component Localization ....................................................................... 16 Resource File Editor utility structure ________________________________ 16 Translating a KWizCom component _________________________________ 17 Use the component in your preferred language _____________________ 18

Component Activation .......................................................................... 19 Administrator Guide .............................................................................. 21 Introduction ________________________________________________________ 21 Web Part Properties & Configuration Options _______________________ 22 Aggregation Source ..................................................................................................... 23 Aggregation Views Definitions ................................................................................... 25 Look & Feel .................................................................................................................... 26

FAQ............................................................................................................... 29 What does the List Aggregator do? __________________________________ 29 What type of SharePoint installation is needed for this web part to work? _______________________________________________________________ 29 Do I have to install anything on my company's client-PCs? __________ 29

Version Release Notes .......................................................................... 30 Version History _____________________________________________________ 30

Technical Support ................................................................................... 32 3 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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, 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 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

Different skins KWizCom SharePoint List Aggregator enable 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 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

12 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

Key Features & Benefits Feature

Standard edition

Supports MOSS 2007 / WSS 3.0



Support Mozilla Firefox



Multilingual (standard for all KWizCom components)



Sleek, AJAX-based user interface, with minimum post backs.



Support grouping and sorting



Ability to use views



Different 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



13 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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 Firefox Mozilla.

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.

14 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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.

15 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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

The captions that should be displayed in your localized language

All internal string names

The default displayed caption for each string in English

16 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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.

17 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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).

18 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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 – www.KWizCom.com. 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 19 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

to send us your product code. 3. Get the component activation key – this key will be sent to you by email 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".

20 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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.

21 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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.

22 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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

23 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com



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.

24 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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..." 25

Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com



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 26

Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com



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 27

Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com



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

28 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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 company's client-PCs?

anything

on

my

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.

29 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

Version Release Notes Primary Software Version

1.3.00

Base version

1.2.00

Release date

Nov-30-2008 Sub-Modules

Module

Version

n/a

n/a

Version History CR #

Description

Version 1.3.00, November-30-2008 34

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 1.2.00, ??-05-2008 33

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 Fixed bug: Using a URL or Image fields in the view definitions displays

39

empty data source message

41

Enable export to PDF

Version 1.1.00, June-05-2008 4

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 30

Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

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

31 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com

Technical Support You can obtain technical support using any of the following methods: The KWizCom Web site The KWizCom website at www.KWizCom.com 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

32 Copyright © 2005-2008 KWizCom corp. All rights reserved. www.KWizCom.com