Installation & User Guide - KWizComcatalog.kwizcom.com/sites/pc/Product Documentation/KWizCom_Sh… · Component Localization ... accessibility standard ... 1. OS: Windows 7, 8 OR

Installation & User Guide

SharePoint Rating Solution

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

2

Copyright © 2005-2013 KWizCom Corporation. All rights reserved.

E-mail: [email protected]

Web site: http://www.KWizCom.com

Sales

E-mail: [email protected]

Telephone: +1-905-370-0333

http://www.kwizcom.com/



3

Table of Contents

Introduction............................................................................................... 4

Product Overview .................................................................................... 5

Why did we build it? ______________________________________ 6

Key Features and Benefits __________________________________ 6

Installation Guide ................................................................................... 8

Software prerequisites ____________________________________ 8

Installation Procedure _____________________________________ 8

Post Installation ________________________________________ 11

Un-installation procedure _________________________________ 12

Component Localization ..................................................................... 13

Resource File Editor utility structure _________________________ 13

Translating a KWizCom component __________________________ 16

Component Activation ____________________________________ 18

Administration Guide ........................................................................... 23

Creating a Rating column __________________________________ 23

Rating Solution Web API __________________________________ 26

Query string parameters: __________________________________ 28

This web service includes a single web method: ________________ 29

User Guide ................................................................................................ 31

FAQ .............................................................................................................. 34

Does rating require authoring rights on a list/library? ___________ 34

Can I use the Rating column in a content type? _________________ 34

Do I need to install anything on my company's client-PCs? ________ 34

Does this solution support WSS and MOSS? ____________________ 34

Technical Support ................................................................................. 35



4

Introduction

KWizCom's SharePoint Rating Solution provides a comprehensive

solution for rating and commenting on SharePoint items and viewing

rated items and their comments.

KWizCom SharePoint Rating Solution supports SharePoint

2007/WSS 3.0, SharePoint 2010 Server/Foundation and SharePoint

2013 Server/Foundation.

This document provides all the information necessary to install,

evaluate, and deploy this KWizCom's SharePoint Rating Solution:

Product Overview

Installation Guide

Administrator guide

User guide

FAQ

Technical Support



5

Product Overview

Web-style rating, voting and "kicking" for your SharePoint

intranet and internet web site!

KWizCom's SharePoint Rating Solution enables users to rate, and

comment on pages, documents and list items.

Rating can be done in various methods: 5-stars rating, voting and

kicking (“like”), now available in SharePoint 2007, SharePoint 2010 and

SharePoint 2013.



6

Why did we build it?

SharePoint 2007 doesn’t provide any rating capabilities.

As for SharePoint 2010 – it does provide new rating capabilities, but

still has some limitations such as:

No support for voting (thumb-up/thumb-down) and liking rating

methods

No support for adding comments to ratings

No support for locking an item from being rated after a defined

date

SharePoint 2013 - provides rating and liking methods but still has the

same limitations regarding comments and locking items for rating.

Key Features and Benefits

Feature SharePoint

Rating

Solution

SharePoint

2007

SharePoint

2010

SharePoint

2013

Support 5-stars rating

method

n/a

(has no

rating

capabilities)

Support voting (thumb-up/

thumb-down)

n/a

Support like voting mode n/a

Rating is available to any

user with reader

permission (no need to

have contributor rights on

the list/library!)

n/a

Automatically displays the

average rating n/a

Enables limiting the amount n/a



7

of votes per-user

A standard Rating column

that enables filtering of items

by the average rating

n/a

Enables users to provide

comments along with the

rating

n/a

A “Details” dialog box

displays all comments for an

item

n/a

Allows users to post multiple

comments

n/a

Displays number of ratings

and number of comments for

every item

n/a

The administrator is allowed

to update/delete users'

comments (administrative

update)

n/a

Enables the administrator to

lock down rating/adding

comments once the voting

period ends

n/a

Provides rating web service

API

n/a

Enables anonymous user

rating

(needed in internet websites)

n/a

Cross browser compatible -

Supports Microsoft Internet

Explorer, Mozilla Firefox,

Google Chrome and Safari

n/a

Partially

supported

Partially

supported

Compliant with the web

accessibility standard

(WCAG)

n/a

Multilingual support n/a



8

Installation Guide

This section describes the installation of the KWizCom SharePoint Rating Solution.

Software prerequisites

Server Requirements

1. SharePoint 2007 / WSS 3.0 or

2. SharePoint Server/Foundation 2010/2013

Client PC Requirements

1. OS: Windows 7, 8 OR Mac iOS 10.8.4 or later.

2. Microsoft Internet Explorer 9+ or Firefox Mozilla (Latest version)

or Google Chrome (Latest version) or Safari (Latest version)

Installation Procedure

SharePoint 2007

1. Log in using SharePoint administrator account to your SharePoint

front-end server.

2. Download the product’s latest evaluation version from KWizCom’s

internet web site. This evaluation version is fully functional for 30

days. Further details about product activation can be found in the

Administrator guide (next section).

3. Unzip the product’s zip file on your SharePoint server.

4. Double-click the .msi file in order to begin the web installation.

5. When the installation process is complete it will recycle all

application pools automatically.



9

SharePoint 2010/2013

1. Log in as SharePoint administrator account to your SharePoint

front-end server.

2. Download the product’s latest evaluation version (zip file) from

KWizCom’s internet web site. This evaluation version is fully

functional for 30 days.

3. Download the KWizCom SharePoint Foundation zip file:

SharePoint 2010:

http://www.kwizcom.com/objects/KWizCom%20SharePoint%20201

0%20Foundation/KWizCom%20SharePoint%20Foundation.zip

SharePoint 2013:

http://www.kwizcom.com/objects/KWizCom%20SharePoint%20201

0%20Foundation/KWizCom%20SharePoint%20Foundation%202013

.zip

REMARK:

KWizCom SharePoint Foundation is a WSP package that includes

all KWizCom’s shared utilities and licensing modules for

SharePoint 2010/2013.

4. Extract both zip files’ content into the same folder on your

SharePoint’s disk.

You will need now to install and deploy these standard SharePoint

WSP packages. This can be done by using SharePoint’s

stsadm/Powershell tools, according to Microsoft’s guidelines for

installing WSP packages.

5. For a much quicker automatic installation, right-click the

“SP-WSPsInstaller.ps1” Powershell script file and select “Run with

Powershell”. This will start the automatic installation and

deployment process.


http://www.kwizcom.com/objects/KWizCom%20SharePoint%202010%20Foundation/KWizCom%20SharePoint%20Foundation.zip

http://www.kwizcom.com/objects/KWizCom%20SharePoint%202010%20Foundation/KWizCom%20SharePoint%20Foundation.zip

http://www.kwizcom.com/objects/KWizCom%20SharePoint%202010%20Foundation/KWizCom%20SharePoint%20Foundation%202013.zip




10

6. At the end of the installation process, you should see all packages

deployed in the Central Admin “Server Solutions” page, and the

KWizCom SharePoint Foundation package should be deployed also

in the Central Admin’s web application.



11

Post Installation

SharePoint 2007

1. After completion of the installation, you will see a new KWizCom entry

in Windows Start -> All Programs -> KWizCom-> SharePoint

Rating Solution containing the following programs:

About SharePoint Rating Solution

Display General Information about the component.

Activate SharePoint Rating Solution

This utility enables you (the SharePoint Administrator) to activate the

downloaded evaluation version.

SharePoint Rating Solution 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.

2. Activate the feature in site collection/s where you want this feature to

be available:


1. After completing the package installation and deployment, Activate the

feature in site collection/s where you want this feature to be available:



12

Un-installation procedure

SharePoint 2007

1. Log in using SharePoint administrator account to your SharePoint

front-end server.

2. Go to Control Panel and double-click Add or Remove Programs.

3. Select product entry and click Remove button.

4. Click Yes to approve the removal of the component.

5. Once the product was un-installed, close the Add or Remove Programs

screen.


1. Retract and remove the solution using SharePoint central admin or by

using stsadm/powershell command line.

That's it! Your Rating Solution is installed. Now, a new Rating field type

is available for you to add to any list or library in SharePoint.



13

Component Localization

Every KWizCom component comes with a 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

The Resource File Editor utility displays the following dialog which

enables the administrator to translate every displayed string (captions,

menu items, user-messages) to the required target language. You can

either translate the strings yourself or upload a translation resource file

which will automatically translate all component strings in the strings

grid.

KWizCom makes avaiilible translation resource files in four major

languages:German, French, Spanish, Russian in addition to the

original English the program was written in. should you desire an

additional language the Resource File Editor utility makes it easy to

implement the necessary translation.



14

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.

Here you select

the target language

The captions that should

be displayed in your

localized language

The default displayed caption for each string

in English

Click to import a

translation resource file.



15

Click the "Load" button and select the proper translation resource file

and the strings will be translated. Click "Create" and a resource file will

be created. If you wish to translate the strings yourself, click "Create"

after you have finished translating all the component strings. 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, create a site

using your required SharePoint Language Pack., The relevant language's

resource file will be used by the component, according to the SharePoint

site language you defined.



16

Translating a KWizCom component

SharePoint 2007

1. On your Windows task bar, select:

Start->All Programs->KWizCom->SharePoint Rating Solution ->

SharePoint Rating Solution Resource Editor

2. Select your target language on the "Select Culture" drop-down list.

3. For translation to French Spanish German and Russian-

Click "Load" and upload the translations resource file.

4. For translation to any other language-Translate all the displayed

strings in the strings grid by entering a translated value in the

"Localized Value" column.

5. Click the "Create"/"Update" button in order to create/save a resource

file for the selected target language.

6. If you want to create additional resource files for more target

languages, simply repeat stages 2-5 for each language.

7. Close the utility by clicking the "Close" button.


1. Go to: C:\Program Files\Common Files\Microsoft Shared\Web Server

Extensions\[14/15]\Resources.

2. Copy the product’s resource file: KWizCom.SharePoint.Rating.resx

to a new resource file, and add to its name the requested language’s

suffix.

Example: to create a French resource file, copy the file to the following

file name:

KWizCom.SharePoint.Rating.fr-FR.resx

3. Update the copied resource file and replace the English strings with the

translated strings.



17

The translatable strings are located inside the <data name> nodes, in

their <value> attributes.

Example:

<data name="btnAccept" xml:space="preserve">

<value>Accept Changes</value>

</data>

4. Save the new resource file.

REMARK:

You can also use the KWizCom Resource Translator Free utility to quickly

translate any KWizCom add-on to your preferred language.


http://www.kwizcom.com/free-downloads/sharepoint-resource-translator/


18

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:

SharePoint 2007

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:




19

Please use the Activation Request web form, on KWizCom web site

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 -> SharePoint Rating

Solution-> Activate SharePoint Rating Solution


1. Order the product on the KWizCom website – www.KWizCom.com,

or contact our sales team at [email protected].

2. After the order was made, you can activate your installed

evaluation version. Activation is done by the following steps:

a. Open SharePoint Central Admin. On the main “Central

Administration” page, you will see the “KWizCom Features

Administration” icon:


http://www.kwizcom.com/ProductReg.asp


mailto:[email protected]


20

b. Click the KWizCom Features Administration icon. You will be

redirected to a page that allows you to manage all your

installed KWizCom products’ licenses:

c. Click the “Manage License” link next to the product that you

wish to activate. You will be redirected to that product’s

license management page:

d. Click on the “Request product code and start your evaluation

now” link, under the required license type (Farm, Web

application, Site Collection).

A product code will be generated and displayed as in the



21

following screenshot:

e. Copy the product code.

f. Browse the Product Activation Request page on KWizCom’s

web site: http://www.kwizcom.com/ProductReg.

Copy your Product Code into the “Product Code” field, and

after you fill-out all other form fields, click “Send Activation

Request button.


http://www.kwizcom.com/ProductReg


22

g. Once your order is confirmed, you will receive the Activation

Code for your product by email.

h. Copy the activation code into the “Activation Code” field in

the product’s license management page and click “Activate

now!” link.

That’s it! Your product is now fully activated.



23

Administration Guide

The KWizCom SharePoint Rating Solution is a custom field type,

packaged as a site collection feature.

The following sections cover the available configuration options for the

deployment of the rating solution.

Creating a Rating column

The SharePoint Rating Solution is actually a standard SharePoint column

that list administrators can create and add to any requested list or

library.

Remark: The Rating field type is also available for the creation of a

Rating site column, enabling you to deploy it as a content type, for an

enterprise-wide solution.

To add a new Rating column, simply click the "Create Column" menu in

the requested library and in the "Create Column" page, select the

"Rating" column type:



24

When you select the "Rating" column type, you will see the following

field properties:

Property Description

Rating Type Select the rating method you’d like to use: 5-stars rating, voting (thumb-up/thumb-down), or liking.

Allow Comments Check this property to allow users to add comments in

addition to the rating.

Allow multiple

comments By default users can give a single rating and comment

per item. Check this property to allow users to add multiple comments.

Add total number of ratings and

comments columns

Checking this property will add 2 more calculated columns (in addition to the Rating column which

displays the rating control):

#Ratings = total number of ratings given for the

item

#Comments = total number of comments given

for the item

Rating period end Select a date field after which the item will be locked for



25

date field any additional ratings/comments.

Maximum number of votes

Use this field in case you want to limit the number of items that can be rated by each user.

The default value of 0 means unlimited.

Example: in a list of candidates, you may want users to rate their 3 most preferred candidates.

"Rating Details"

page Display Mode Select the display mode of the Rating Details page:

All Ratings – show all ratings

Only Comments – Show only ratings given with

comments



26

Rating Solution Web API

The Rating solution also provides an API which enables rating items and

displaying item ratings using Web URL’s.

This is useful for example if you want to include a rating feature inside

an InfoPath web form, or in any other web form.

Pages URLs

SharePoint 2010

/_layouts/KWizCom_RatingSolution/RatingPage.aspx

SharePoint 2013

/_layouts/15/KWizCom_RatingSolution/RatingPage.aspx

This page returns 5 stars - rate by clicking, no buttons:



27

If you add to this URL the querystring parameter “&comment=true” it

will open in comments mode only (no stars, just comment text box and submit button):



28

SharePoint 2010-

/_layouts/KWizCom_RatingSolution/CommentsPage.aspx

SharePoint 2013-

/_layouts/15/KWizCom_RatingSolution/CommentsPage.aspx

This page displays the comments/ratings for a selected item:

Query string parameters:

itemId= item Guid or item ID

listId= list Guid or list name

ratingFieldId= field Guid or field name

ShowPastComments=false=hide the past comments



29

Web service URL

The Rating solution provides also a web service API:

/rating/_vti_bin/KWizCom_RatingSolution/Rating.asmx

This web service includes a single web method:

Public RatingEntries GetItemRating(string listId, string itemId)

This method returns all ratings data for a required list item, and enables

users to rate this item by using the 5 stars image, which is also retured by this web method.

You can display rating data in InfoPath or in a SharePoint page using SharePoint Designer by adding a data source from web service.

In the following example we have used the Rating solution web service

as data source in an InfoPath web form:



30



31

User Guide

Rating columns shows up in the list view of your choice (like any other

column):

Now, users (including those who have only reader rights on this list or

library) can rate any document by simply clicking the field:



32

Once people provide ratings and comments for the various documents,

the Rating field of each document highlights the star icons according to

the average rating of the document, as seen below:

When hovering over the rating field’s stars, the average document

rating and the number of people that rated is displayed in a tooltip.

All the comments for each item can be viewed by clicking the Rate &

Comment link. The comments are displayed in a pop-up dialog box:

The user can choose whether to see only the comments or view all the

ratings by clicking on the radio buttons.

Site collection administrators can also delete or edit comments (An

edited comment will appear as added by the original user and revised

by the site collection administrator).



33

REMARK: The "Rate & Comment" popup window is fully

customizable. An implementer can change the page layout by

modifying “CommentsPopup.aspx” page into “C:\Program

Files\Common Files\Microsoft Shared\web server

extensions\12\TEMPLATE\LAYOUTS\KWizCom_RatingSolution”

folder.

Anonymous user rating enabled

The SharePoint Rating Solution also supports ratings by anonymous

users – ideal for internet web sites!

Web service Rating API

The SharePoint Rating provides now a Web Service API which enables

rating web items using a web service!

Now you can for example, include rating capabilities in your InfoPath

web forms by using the Rating solution web service as a data source:

All rating solution fields are

exposed as controls in

InfoPath web form



34

FAQ

Does rating require authoring rights on a

list/library?

No. Rating can be done by all users who have (at least) “Reader” rights.

When rating a list item (or a document), the item is not updated by the

user. That is, its Updated and Updated By fields are not changed.

Can I use the Rating column in a content

type?

Yes. You can create a Rating site column, and then add it to any content

type you wish.

Do I need to install anything on my

company's client-PCs?

No. KWizCom SharePoint Rating Solution is a server installation.

Does this solution support WSS and MOSS?

Yes. KWizCom SharePoint Rating Solution supports both MOSS 2007/WSS 3.0 and SharePoint 2010/2013 Server/Foundation.



35

Technical Support

Technical support is available via any of the following:

The KWizCom Web site

The KWizCom website, www.KWizCom.com, contains up to date

information, including:

o Answers to frequently asked questions (FAQ's) about our

products, their usability, and technical questions.

o Product updates, which include bug fixes and new features.

The Web Form

For technical support via the Internet, fill in the support web form

on our web site.

For further technical support, please review our support programs page.



http://www.kwizcom.com/ProductSupport.asp

http://www.kwizcom.com/ProductSupport.asp

http://www.kwizcom.com/ContentPage.asp?PageId=57

Documents

Installation & User Guide - KWizComcatalog.kwizcom.com/sites/pc/Product Documentation/KWizCom_Sh… · Component Localization ... accessibility standard ... 1. OS: Windows 7, 8 OR