Installation & User Guide

Transcription

1 SharePoint Favorite Documents Installation & User Guide

2 Copyright 2005 KWizCom LTD. All rights reserved. Company Headquarters 10 Ruddington St. Toronto M2K 2J7 Canada Web site: Sales Telephone: +1- (412)

3 Table of Contents Introduction...4 Overview 5 Installation...6 Software prerequisites 6 Installation Procedure 6 Post Installation 7 Component Localization...8 Resource File Editor utility structure 9 Translating a KWizCom component 10 Use the component in your preferred language 10 Component Activation...11 FAQ...13 What exactly does KWizCom SharePoint Favorite Documents do? 13 What changes does this add-on make to the SharePoint GUI? 13 Do I have to install anything on my company's client-pcs? 13 I don t see the "My Favorites" view in the document library's view list, why? 13 Version Release Notes...14 New Added Features 14 This Version's Known Issues/Limitations 14 Technical Support

4 Introduction KWizCom SharePoint Favorite Documents is an MS SharePoint add-on that enables users to define requested documents as "Favorite" documents in every SharePoint document library. This document provides all the information needed to install, evaluate and deploy this KWizCom product: Product overview Installation guide Component localization Component activation User guide FAQ Version release notes 4

5 Overview KWizCom SharePoint Favorite Documents adds a new "Add to Favorites" menu item to every SharePoint document library: Clicking the new "Add to Favorites" menu add the selected document to the "My Favorites" view. "My Favorites" view displays the user's favorite documents in the current document library When a user adds a selected document to his/her favorites, the document is added to the new "My Favorites" view. This way, each user can define his own favorite documents for every SharePoint document library. 5

6 Installation Software prerequisites Server Requirements 1. Microsoft Windows SharePoint Services (WSS) SP1/SP2 2. Microsoft Office SharePoint Portal Server 2003 (SPS) Client PC Requirements 1. Microsoft Windows XP - SP2 2. Microsoft Office SP1 3. Microsoft Internet Explorer 6+ SP1 Installation Procedure 1. Unzip the KWizCom SharePoint Favorite Documents zip file on your WSS/SPS Windows 2003 Server. 2. Double-click the.msi file in order to begin the web installation. 3. When the installation process is complete, you need to restart the IIS Server: Open the Command Prompt on your server. Type iisreset 6

7 Post Installation 1. After completion of the installation, you will see a new KWizCom entry in Windows Start -> All Programs -> KWizCom containing 2 programs: About SharePoint Favorite Documents Display General Information about the component. Activate SharePoint Favorite Documents This utility enables you (the SharePoint Administrator) to activate the downloaded evaluation version. SharePoint Favorite Documents User Guide Link to user-guide document (.PDF). SharePoint Favorite Documents 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. Before users can use the new offline feature added to your existing SharePoint sites, they will have to configure the following Internet Explorer settings: Empty Internet Explorer's cache. This is done by selecting "Tools->Internet Options" on the Internet Explorer menu bar. Set the SharePoint server as a Trusted Site. This is done be selecting "Tools->Internet Options->Security", and adding the SharePoint server's URL to the Trusted sites list. 7

8 On the "Internet Options" dialog click the "Delete Files" button, and then click "OK". 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. 8

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

10 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 Favorite Documents -> SharePoint Favorite Documents 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. 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). 10

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

12 4. Activate your installed evaluation version - click Start -> All Programs -> KWizCom -> SharePoint Favorite Documents -> Activate SharePoint Favorite Documents 12

13 FAQ What exactly does KWizCom SharePoint Favorite Documents do? This add-on adds a new "Add to Favorites" menu item to every SharePoint document library. Clicking this menu for a selected document will add the document to a "My Favorites" view. This way, users can define their personal favorite documents fr every SharePoint document library. What changes does this add-on make to the SharePoint GUI? After you install KWizCom SharePoint Favorite Documents you will see 2 changes in the SharePoint GUI: 1. A new "Add to Favorites" menu is added to the document dropdown menu bar. 2. A new "My Favorites" view is added to the "Select View" pane. Do I have to install anything on my company's client-pcs? No. KWizCom KWizCom SharePoint Favorite Documents is a server installation. I don t see the "My Favorites" view in the document library's view list, why? This is because "My Favorites" view is not a real SharePoint view. Therefore you can not display this view inside a web part, and can access it only from the document library page. 13

14 Version Release Notes Primary Software Version Base version n/a Release date Dec Sub-Modules Module Version n/a n/a New Added Features n/a This Version's Known Issues/Limitations CR # Description 14

15 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 For more information on technical support, please review our support programs page. 15