My Recent Documents Web Part - KWizCom My Recent Documents user gui… · Sales E-mail: [email protected] Telephone: ... Administrator's Guide ... 5 Defines the maximum number of

Installation & User Guide

My Recent Documents Web Part

Copyright © 2005 KWizCom Ltd. All rights reserved. www.KWizCom.com

2

Copyright © 2005 KWizCom LTD. All rights reserved.

Company Headquarters

P.O. Box #.38514

3299 Bayview Ave.

North York, Ontario

M2K 2Y5

Canada

E-mail: [email protected]

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

Sales

E-mail: [email protected]

Telephone: +1- (412)-567-7666


3

Table of Contents

Introduction _____________________________________________________4

Overview ____________________________________________________________ 5

Key Features & Benefits ____________________________________________ 6

Installation ______________________________________________________7

Software prerequisites _____________________________________________ 7

Installation Procedure ______________________________________________ 7

Post Installation ____________________________________________________ 8

Component Localization_________________________________________9

Resource File Editor utility structure ______________________________ 9

Translating a KWizCom component _______________________________ 10

Use the component in your preferred language__________________ 11

Component Activation__________________________________________12

Administrator's Guide __________________________________________13

Introduction ________________________________________________________ 13

Web Part Properties & Configuration Options____________________ 13

Search Options____________________________________________________________14

Display Options __________________________________________________________15

FAQ ______________________________________________________________17

I always get the "there were no results" message, why? _______ 17

I have just created a new document. Why doesn’t the web part

show it?_____________________________________________________________ 17

Does the web part show recently created\edited list items as well as documents? ________________________________________________ 17

Why does the web part show different items than the built-in Microsoft web part (“your recent documents”)?_________________ 18

Does the web part also show recently added pictures? _________ 18

Version Release Notes _________________________________________19

New Added Features _______________________________________________ 19

This Version's Known Issues/Limitations ________________________ 19

Technical Support ______________________________________________20


4

Introduction

KWizCom My Recent Documents Web Part is a Microsoft SharePoint Portal

server web part that enables users to see a list of the recent documents

they have edited or created on the corporate SharePoint portal (SPS) or

any Windows SharePoint Services (WSS) team site.

This document provides all the information needed to install, evaluate and

deploy this KWizCom product:

�� Product overview

�� Installation guide

�� Component localization

�� Component activation

�� Administrator guide

�� FAQ

�� Version release notes


5

Overview

KWizCom My Recent Documents Web Part enables users to see a list of

the document and\or listings they have recently created and\or edited.

This web part provides enhancements over the "Your recent documents"

web part that comes built-in with MS SharePoint Portal Server.

What's new?

SharePoint's built in "Your Recent Documents" web part offers little

customization. It shows a list to the recent documents without further

information or useful links about the documents. KWizCom My Recent

Documents Web Part provides more features and customization options.

Tooltip with

document's properties

Edit link

Link to the

document's folder


6

Key Features & Benefits

�� Shows an "Edit" link to the document properties page or the

document itself.

�� Shows a link to the document library or to the topic that the

document or listing is in.

�� Allows the administrator to choose what type of items the web part

displays – documents, listings or both.

�� Shows a tool tip for every document with document properties such

as creation date, last modified date, author, title and site.

�� Allows trimming long titles – (saves valuable screen space!)

�� Fully configurable – allows changing styles and images to fit your

own portal design.

�� No client installation needed – easy & fast deployment

�� Multi-lingual (standard for all KWizCom components)


7

Installation

Software prerequisites

Server Requirements

1. Microsoft Office SharePoint Portal Server 2003 (SPS) + SP1/SP2

Client PC Requirements

1. Microsoft Internet Explorer 6+ SP1

2. Trusted site setting for the portal site (To allow the "Edit Document"

link to work)

Installation Procedure

1. Unzip the KWizCom My Recent Documents Web Part zip file on your

SharePoint Portal Server.

2. Double-click the .msi file in order to begin the web part's installation.

3. When the installation process is complete, you need to restart the IIS

Server:

• Open the Command Prompt on your server.

• Type iisreset


8

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 SharePoint My Recent Documents Web Part

Display General information about the component.

Activate SharePoint My Recent Documents Web Part

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

downloaded evaluation version.

SharePoint My Recent Documents Web Part User Guide

Link to user-guide document (.PDF).

SharePoint My Recent Documents Web Part 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:

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


9

Component Localization

Every KWizCom component comes with localization utility called the

"Strings 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

The default displayed

caption for each string in English

All internal string

names


10

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-> My Recent Documents Web

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


11

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


12

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. Get the component activation key – this key will be sent to you by

email once your order is processed.

3. Activate your installed evaluation version -

click Start -> All Programs -> KWizCom ->

Activate SharePoint My Recent Documents Web Part


13

Administrator's Guide

Introduction

KWizCom My Recent Documents Web Part enables users to see a list of

documents that they have recently created or modified. The web part also

provides links to edit the document or its properties, as well as additional

information about the file.

The web part works only on SharePoint Portal server pages and not in

WSS sites.

Web Part Properties & Configuration Options

The web part has various properties you can set to change the way the

web part behaves. These properties are grouped in three categories:

• Search Options

• Display Options

• Miscellaneous

The following section describes each category and each property and

explains the affect it has on the web part’s behavior.


14

Search Options

Property Name Default Value

Description

Maximum Number of Items to Display

5 Defines the maximum number of documents that will be shown by the web part. This limits the web part to show only the most recent documents.

You can specify 0 to remove the limitation and show all the documents that were found.

Date Range (days)

7 Defines the number of days to look for changes. Only documents that were created and\or changed in the specified date range will be included in the

results. You can specify 0 to remove the limitation and show all the documents that the user ever created

and\or edited.

Item Type Documents Select from the available options of documents\listings\both to define what sort of

results the web part will display.

Display Only

Items that the Current User has Created\Updated

Both Select from the available options of

created\edited\both to define how the web part will search for document. The web part will only look for documents that the current user has

either created, edited or both.

Search for Items

According to their Creation/Modify Date

Modified Select from the available options of

created\Modified to define how the web part will search for document. The web part will only look for documents that the current user has either

created or edited in the specified date range.


15

Display Options


Property Affect

Title Max Length (Characters)

60 Defines how many characters of the title will be shown to the user if the document’s title is long. This allows for trimming the web part to be small

and compact. Titles longer than the specified values will be trimmed, and three dots will be added.

Display Document Type Icon

True Defines if the web part should show the document type icon. This will cause the web part to try to show the user what kind of document

he sees (word\excel\html ect.). If a document has an unknown file extension, the icon will be displayed as a red X. To add new

document icons, save a 16X16 gif file in the “C:\Program Files\Common Files\Microsoft Shared\web server

extensions\60\TEMPLATE\IMAGES” directory on the SharePoint Portal Server machine. The file should be named [FileExtension]16.gif (for

example “pdf16.gif” for pdf files)

Display Edit Link True Defines if an “Edit” button will be shown to the


16


Property Affect

user. The edit button may have different behaviors (see the following properties).

Edit Link Will Edit Document\Properties

Document Select from available options of Document\Properties to define what will happen

when the user presses an Edit Link. If “Documents” is selected, the link will attempt to open the document in an editable mode

(works with Office supported documents only). If “Properties” is selected, the link will open (in a new window) the document properties page for

the document.

Edit Link Image Edititem.gif The image that will be shown as a link to editing the document. You may replace this with a URL

to any image you want.

Edit Link Tool Tip Edit The text that the user will see when hovering

over the edit link’s image.

Display Library\Topic

Link

True Define if to show the user a link to the document

library the document is in, or to the topic the listing is in (based on the item type)

Library Link Image Folder.gif The image that will be shown as a link to a

documents library. You may replace this with a URL to any image you want.

Library Link Tool Tip Open Library The text the user will see when hovering over the Open Library Link’s Image

Topic Link Image Topic.gif The image that will be shown as a link to a portal

topic. You may replace this with a URL to any image you want.

Topic Link Tool Tip Open Area The text the user will see when hovering over the Open Topic Link’s Image

Show Errors False Defines if the user will be shown the entire

details of an error when one occurs in the web part. False will cause only the “friendly error” to be

displayed (see the following property)


17

FAQ

I always get the "there were no results"

message, why?

There are a number of possible reasons for this to happen:

• The user didn’t create or edit any document in the specified date

range.

• The web part is set to display listings only, and the user expects to

see new documents, or vice versa.

• The Microsoft SharePoint Portal Server Search is not functioning

properly. In this case the administrator should check if the problem

exists for all users or just for one user. If all users are affected, it is

recommended to check the SharePoint search engine and to test if

the built in “Your recent documents” web part and see if it works. If

it doesn’t work, it is recommended to ask a SharePoint expert to

check the search engine.

I have just created a new document. Why

doesn’t the web part show it?

The web part relies on Microsoft SharePoint Portal Server Search engine

to get the list of documents. When you create a new document, it takes a

while for the search engine to include the new document in its index.

When the search engine will run an update on the index, you will see the

new document in the list.

Does the web part show recently created\edited

list items as well as documents?

No. The web part only shows documents in document libraries and\or

listings in topics. Future versions of the product may or may not support

additional item types.


18

Why does the web part show different items

than the built-in Microsoft web part (“your

recent documents”)?

Microsoft’s built-in web part may shows recently changed web part pages

and sites. Most users do not change web part pages, and when they do, it

is not often that they wish to view the changes in a documents-oriented

web part. This web part has been designed to help information workers to

work with the information it self, and not for site administrators to view

changed pages.

Does the web part also show recently added

pictures?

No. The web part only shows documents and listings. Pictures are not

registered as documents by Microsoft SharePoint Portal Server search.


19

Version Release Notes

Primary Software

Version 1.2.0

Base version n/a

Release date Jan-10-2006

Sub-Modules

Module Version

n/a n/a

New Added Features

n/a

This Version's Known Issues/Limitations

CR # Description


20

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.

�� Tips and usage scenarios.

The Web Form

For technical support through the Internet, please fill in our support web

form on our web site:

www.KWizCom.com/supportForm

For more information on technical support, go to:

www.KWizCom.com/support