Installation & User Guide

Transcription

1 SharePoint Rating Solution Installation & User Guide

2 Copyright KWizCom Corporation. All rights reserved. Web site: Sales Telephone:

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 Resource File Editor utility structure 13 Translating a KWizCom component 16 Component Activation 18 Administration Guide 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 FAQ 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

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 4

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

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 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 n/a Support 5-stars rating (has no method rating capabilities) Support voting (thumb-up/ n/a thumb-down) Support like voting mode n/a Rating is available to any user with reader permission (no need to n/a have contributor rights on the list/library!) Automatically displays the average rating n/a Enables limiting the amount n/a 6

7 of votes per-user A standard Rating column n/a that enables filtering of items by the average rating Enables users to provide n/a comments along with the rating A Details dialog box n/a displays all comments for an item Allows users to post multiple n/a comments Displays number of ratings n/a and number of comments for every item The administrator is allowed n/a to update/delete users' comments (administrative update) Enables the administrator to n/a lock down rating/adding comments once the voting period ends Provides rating web service n/a API Enables anonymous user n/a rating (needed in internet websites) Cross browser compatible - n/a Supports Microsoft Internet Partially Partially Explorer, Mozilla Firefox, supported supported Google Chrome and Safari Compliant with the web n/a accessibility standard (WCAG) Multilingual support n/a 7

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 or later. 2. Microsoft Internet Explorer 9+ or Firefox Mozilla (Latest version) or Google Chrome (Latest version) or Safari (Latest version) Installation Procedure SharePoint 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. 8

9 SharePoint 2010/ 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: 0%20Foundation/KWizCom%20SharePoint%20Foundation.zip SharePoint 2013: 0%20Foundation/KWizCom%20SharePoint%20Foundation% zip REMARK: KWizCom SharePoint Foundation is a WSP package that includes all KWizCom s shared utilities and licensing modules for SharePoint 2010/ 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. 9

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

11 Post Installation SharePoint 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: SharePoint 2010/ After completing the package installation and deployment, Activate the feature in site collection/s where you want this feature to be available: 11

12 Un-installation procedure SharePoint 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. SharePoint 2010/ 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. 12

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

14 Here you select the target language Click to import a translation resource file. The captions that should be displayed in your localized language The default displayed caption for each string in English 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. 14

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

16 Translating a KWizCom component SharePoint 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. SharePoint 2010/ 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. 16

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

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 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: 18

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 once your order is processed. 4. Activate your installed evaluation version - click Start -> All Programs -> KWizCom -> SharePoint Rating Solution-> Activate SharePoint Rating Solution SharePoint 2010/ Order the product on the KWizCom website or contact our sales team at sales@kwizcom.com. 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: 19

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 20

21 following screenshot: e. Copy the product code. f. Browse the Product Activation Request page on KWizCom s web site: Copy your Product Code into the Product Code field, and after you fill-out all other form fields, click Send Activation Request button. 21

22 g. Once your order is confirmed, you will receive the Activation Code for your product by . 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. 22

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: 23

24 When you select the "Rating" column type, you will see the following field properties: Property Rating Type Allow Comments Allow multiple comments Add total number of ratings and comments columns Rating period end Description Select the rating method you d like to use: 5-stars rating, voting (thumb-up/thumb-down), or liking. Check this property to allow users to add comments in addition to the rating. By default users can give a single rating and comment per item. Check this property to allow users to add multiple comments. 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 Select a date field after which the item will be locked for 24

25 date field Maximum number of votes "Rating Details" page Display Mode any additional ratings/comments. 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. Select the display mode of the Rating Details page: All Ratings show all ratings Only Comments Show only ratings given with comments 25

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: 26

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): 27

28 SharePoint /_layouts/kwizcom_ratingsolution/commentspage.aspx SharePoint /_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 28

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: 29

30 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: 31

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

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 33

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

35 Technical Support Technical support is available via any of the following: The KWizCom Web site The KWizCom website, contains up to date information, including: o o Answers to frequently asked questions (FAQ's) about our products, their usability, and technical questions. 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. 35