SharePoint Tagging Feature
Installation & User Guide
Copyright © 2005-2011 KWizCom Corporation. All rights reserved.
Company Headquarters KWizCom 50 McIntosh Drive, Unit 109 Markham, Ontario ON L3R 9T3, Canada
E-mail:
[email protected] Web site: http://www.KWizCom.com Sales E-mail:
[email protected] Telephone: +1-905-370-0333
2 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Table of Contents Introduction..........................................................................................................5 Overview ................................................................................................................6 Why did we build it? __________________________________________________ 7 Key Features & Benefits _______________________________________________ 7
Installation............................................................................................................9 Software prerequisites ________________________________________________ 9 Installation Procedure ________________________________________________ 9 SharePoint 2007 ............................................................................................................ 9 SharePoint 2010 .......................................................................................................... 10 Post Installation ____________________________________________________ 11 Un-Installation Procedure ___________________________________________ 14
Component Localization .................................................................................15 Resource File Editor utility structure ________________________________ 15 Translating a KWizCom component _________________________________ 17 Use the component in your preferred language _____________________ 18
Component Activation .....................................................................................19 User Guide ...........................................................................................................24 Tagging Feature modules ___________________________________________ 25 Tags Field Type ............................................................................................................ 25 Tag Cloud Web Part .................................................................................................... 27 Tags Search page........................................................................................................ 30 Tagging Feature integration with MOSS's search results page ......................... 31 Tags Import/Export .................................................................................................... 32 Tagging by anonymous users _______________________________________ 33 Tagging from Microsoft Office applications __________________________ 33 Control new tags creation ___________________________________________ 33 Cross browser support ______________________________________________ 34
Administration Guide.......................................................................................35 Tag Cloud web part - Introduction __________________________________ 35 Web Part Properties & Configuration Options _______________________ 35 Tags List Settings ........................................................................................................ 36 General Properties ...................................................................................................... 37 Display Properties ....................................................................................................... 38 Errors ............................................................................................................................. 39 Tagging Feature Management _______________________________________ 40 Tagging Feature General Settings ........................................................................... 40 Managing Tags Lists ................................................................................................... 43 Adding the Tag Field to SharePoint lists ................................................................ 44 Integrate the Tagging feature with MOSS search results page ........................ 46 3 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
KWizCom Tagging Feature Client Extensions ....................................................... 53
FAQ ........................................................................................................................59 Why do I need the SharePoint Tagging Feature? ____________________ 59 Does the Tagging feature support hierarchical category trees? ______ 59 Does the Tagging Feature support WSS? ____________________________ 59 How do I create new tags? __________________________________________ 60 We already have a defined taxonomy; can we import it to SharePoint? _____________________________________________________________________ 60 Can we use SharePoint Tagging Feature to implement a central, cross site taxonomy in our company? _____________________________________ 60 How do I delete tags? _______________________________________________ 61 Do I need to install anything to use the Tagging client extensions? _ 61 Do I have to install anything on my company's client-PCs? __________ 61 Version History _____________________________________________________ 62
Technical Support .............................................................................................67
4 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Introduction KWizCom SharePoint Tagging Feature provides a complete taxonomy management solution for SharePoint 2007/2010.
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
5 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Overview Complete, Enterprise Taxonomy Management Solution for SharePoint 2007/2010! KWizCom SharePoint Tagging Feature provides an extensive taxonomy management solution for SharePoint-based implementations:
Document Management
Collaboration workspaces
Portals
Internet web sites
This all-in-one solution supports both Web 2.0-style tagging and hierarchical/structured categories.
6 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Why did we build it? SharePoint 2007 doesn’t provide any tagging/taxonomy management capabilities. As for SharePoint 2010 – it does provide new tagging capabilities, but still has some limitations such as:
The new taxonomy features exist only in SharePoint server, so SharePoint
Foundation
users
don’t
get
any
taxonomy
management capabilities.
No built-in ability to tag external web content (tag content located in other web systems in the enterprise)
No support for tag-level permissions and approval routing
No support for cross site collection taxonomy management
Key Features & Benefits Feature
KWizCom Tagging Feature
SharePoint 2007
SharePoint 2010
Supports both SharePoint server and WSS/SharePoint Foundation
N/A
Supports SharePoint Server only
Cross site collection taxonomy management
Enables tagging external web content using web service API
N/A N/A
Tag Cloud view
N/A
Tag Index view
N/A
Supports hierarchical category trees
N/A
N/A
Support multi-parent hierarchical category trees Displays tags as a menu bar, enabling logical navigation (category-based navigation)
N/A
Enables sorting and filtering tags by views
N/A
N/A
Tags Email alert subscription - alert users when an Item was tagged according to tags they subscribed
7 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
to (with the option to unsubscribe) Automatic tagging of email messages: when a user adds a token {TAG:[tag1;tag2;tag3]} to the email subject it will automatically tag the email sent to email enabled library.
N/A
Tag-level permissions
N/A
Filter tags by permissions and views (different users may see different tags according to permissions and views)
N/A
Define max. amount of tags to display in the Tag Cloud
N/A
Supports multiple tags lists, in different scopes
N/A
Supports Anonymous access
N/A
Fully integrated with SharePoint search results
N/A
Can be used in content types and as independent site columns
N/A
Supports tagging documents directly from Office 2007/2010 applications
N/A
Control new tags creation
N/A
All user interfaces are fully customizable using .CSS and web user control (.ascx).
N/A
Taxonomy import utility enables importing vocabularies from CSV/XML and 3rd-party formats such as WAND formats.
N/A
Faceted search (ability to filter search results by category)
N/A
Multilingual (standard for all KWizCom components)
N/A
Cross-browser compatible (IE, Firefox and Google Chrome)
N/A
Supports .CSV only
Partial support
8 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Installation Software prerequisites Server Requirements 1. SharePoint 2007 / WSS 3.0 or 2. SharePoint Server/Foundation 2010 Client PC Requirements 1. Windows Vista/Windows 7 2. Microsoft Internet Explorer 7,8,9 / Mozilla Firefox (Latest version) / Google Chrome (Latest version)
Installation Procedure SharePoint 2007 1. Log in using SharePoint administrator account to your SharePoint front-end server. 2. Unzip the KWizCom SharePoint Cascading Lookup Plus Field installation zipped file on your server. 3. Double-click the .msi file in order to begin the installation.
When the installation process is complete it will recycle all application pools automatically.
IMPORTANT: If you are upgrading an existing installation: After you have completed the installation you may need to run installation once again and perform a "repair" operation, due to files locked by IIS.
9 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
SharePoint 2010 1. Log in as SharePoint administrator account to your SharePoint frontend 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. Extract the zip file content on your local disk. 4. You will find 2 .WSP files: The product’s WSP file and KWizCom foundation WSP file. If you don’t already have the KWizCom Foundation latest version installed - install and deploy the KWizCom Foundation .WSP file in a farm level (All web applications) by using the standard SharePoint’s deployment tools (stsadm, powershell, Central admin).
IMPORTANT: You need to install KWizCom Foundation in a global scope, including in the Central Admin’s web application.
Install and deploy the product’s .WSP file in the farm level, by using the standard SharePoint’s deployment tools (stsadm, powershell, Central Admin).
Remark: The package can be deployed only globally since it deploys a custom field type. Custom field types cannot be deployed in a web application level.
Remark: Installation and deployment of standard SharePoint .WSP packages are described in Microsoft website: http://technet.microsoft.com/en-us/library/cc263384(office.12).aspx http://technet.microsoft.com/en-us/library/ff621081.aspx
10 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Post Installation SharePoint 2007 1. After completing the installation, you will see a new KWizCom entry in Windows Start -> All Programs -> KWizCom containing the following programs: About SharePoint Tagging Feature Display General Information about the component. Activate SharePoint Tagging Feature This utility enables you (the SharePoint Administrator) to activate the downloaded evaluation version. SharePoint Tagging Feature Resource Editor This utility enables you (the SharePoint Administrator) to translate the component to your local language. Please review the next sections for more information about component localization and activation.
2. In order to start working with the Tagging Feature, you have to activate the feature in the relevant site collection/s. Go to the site settings at the root level and click on "Site collection features" located under "Site Collection Administration":
11 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
3. Locate "KWizCom Tagging Feature" and click the "Activate" button next to it:
That's it! Your KWizCom SharePoint Tagging Feature is up and running!
4. When you browse your SharePoint Portal/Windows SharePoint Services site, a new Tagging Feature Web Part will be available for you under "Virtual Server Gallery". 5. In the root level's site settings you will find the "KWizCom Tagging Feature Management":
There you can configure general settings for the KWizCom Tagging Feature (see the Administration Guide in order to find out how).
12 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
SharePoint 2010
1. After completing the package installation and deployment, a new farm feature will be automatically activated:
13 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
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.
SharePoint 2010 1. Retract the solution using SharePoint central admin or by using stsadm/powershell command line.
14 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
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. The following section describes this utility and the translation process.
Resource File Editor utility structure This utility displays the following dialog which 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
15 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
The application displays 2 controls:
1. "Select Culture" drop-down – contains a list of target languages. 2. 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 a MS SharePoint-based component - create a site using your required SharePoint Language Pack. The component will use the relevant language's resource file, according to the selected SharePoint site language.
16 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Translating a KWizCom component SharePoint 2007 1. On your Windows task bar, select: Start->All Programs->KWizCom->SharePoint Tagging Feature web part->
SharePoint Tagging Feature 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. SharePoint 2010 1. Go to: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\Resources. 2. Copy the product’s resource file: KWizCom.SharePoint.WikiPlus.TagsSupport.TagFieldType.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.WikiPlus.TagsSupport.TagFieldType.fr-FR.resx 3. Update the copied resource file and replace the English strings with the
translated strings. The translatable strings are located inside the nodes, in their attributes. Example: Accept Changes
4. Save the new resource file. 17 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
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-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Component Activation SharePoint 2007 KWizCom components are available for evaluation prior to purchase. You are welcome to try our components and verify that they indeed meet your needs. The evaluation version for each KWizCom component contains all features included in the component's production version. The only difference between the versions is that the evaluation will time-out after one month. Once you decide to order a KWizCom component, follow the steps detailed below: 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:
Note: 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.
19 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
4. Activate your installed evaluation version - click Start -> All Programs -> KWizCom -> SharePoint Tagging Feature -> Activate SharePoint Tagging Feature web part
SharePoint 2010 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:
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:
20 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
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 following screenshot:
21 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
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. g. Once your order is confirmed, you will receive the Activation Code for your product by email. 22 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
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 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
User Guide KWizCom SharePoint Tagging Feature provides an extensive taxonomy management solution for SharePoint-based implementations:
Document Management
Collaboration workspaces
Portals
Internet web sites
This all-in-one solution supports both Web 2.0-style tagging and hierarchical/structured categories.
24 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
So…
Why is KWizCom's SharePoint tagging feature called: "Enterprise Taxonomy Management Solution"? Because KWizCom's SharePoint Tagging Feature enables you to tag external content, located in any other system in your organization!
No matter where your web content is located – you can tag it and easily find it!
Tagging Feature modules Tags Field Type By using this field type you can tag any SharePoint list/library items. The Tags field type enables contributors to tag items, Web 2.0 style:
Textual tags with auto-complete feature
25 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Or connect content items to hierarchical, centrally-managed categories:
26 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
The “Tags” field type behaves like any other column – allowing you to use the field in list views and filter items according to tags:
Tag Cloud Web Part The Tag Cloud web part allows you to view your tags in 4 different convenient ways:
Tag Cloud View: Each tag has a different size which is determined by the ratio of its usage in comparison with other tags. This way it is easy to identify what tag your users are using the most, while still having a full picture of all site tags.
27 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Tag Index View: In this view the tags are listed and sorted alphabetically, for easier access to all tags.
28 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Category Tree: In this view the tags are displayed as a category tree with parent-child relationships. This view also enables filtering tags by a tag name (using a text box):
Text filtering enables you to display a filtered view of your taxonomy
29 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Tag Menu: In this view the tags are displayed as a menu bar, easily integrated in SharePoint's Master page to provide logical, cross-site navigation by categories.
Tags Search page KWizCom Tagging Feature is fully integrated with the WSS/MOSS search engine. Once you click a tag/category it will pull up all content items (cross site & cross site-collection) that are tagged to the selected tag:
30 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
You can click on the item's title to see its details. Click on the "Subscribe" link (located at the top right corner of the page) in order to receive email notification when an item has been tagged with the tag you selected, or when a tagged item has been modified by a signed in or an anonymous user!
Tagging Feature integration with MOSS's search results page KWizCom Tagging Feature is fully integrated with the MOSS 2007 search results page to provide faceted search functionality – the ability to fine tune the search results by clicking a selected tag/category.
MOSS 2007 search results page
Easily embed the Tag Cloud/Category tree and filter search results by a selected Tag/Category (Faceted Search)
31 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Cross-system Tagging KWizCom's SharePoint Tagging Feature now includes a new Web Service interface, which enables you to tag any web content, located anywhere in your organization! Now you can use SharePoint to tag and search for external content with ease, according to your organization's taxonomy structure.
Tags Import/Export SharePoint Tagging Feature includes an import/export utility that enables you to import/export taxonomies from/to CSV files and from WAND (Domain vocabularies vendor and KWizCom partner) XML files, into/from SharePoint tags lists.
You can now deploy the taxonomy you need, matched to your company's domain. Together KWizCom and WAND have enabled you to implement a taxonomy that includes thousands of tags/keywords in just a few minutes!
32 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Tagging by anonymous users The tagging feature supports Anonymous users as well, thus enabling the deployment of this complete tagging solution as a part of Internet web site.
Tagging from Microsoft Office applications The “Tags” field type enables users to tag information from within Office 2007 applications. Users can tag documents directly from the Office 2007 property panel:
Control new tags creation When creating the “tags” column, you can enable or disable the option to create new tags, by checking the "Allow users to add new tags" checkbox:
33 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
This tool enables you to define a Tags field such that content editors are permitted to tag content but prevented from adding new tags or deleting existing tags.
Cross browser support KWizCom Tagging Feature is compatible with Microsoft Internet Explorer, Mozilla Firefox and Google Chrome. This makes it the perfect solution both for Intranet and Internet knowledge sharing solutions.
34 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Administration Guide The KWizCom SharePoint Tagging Feature combines three major components that, together, provide a complete tagging solution:
Tag Cloud web part
Tag Field Type
Tagging client extensions
The following section will cover these three components, starting with the Tag Cloud web part:
Tag Cloud web part - Introduction When you browse your SharePoint Portal/Windows SharePoint services site, a new KWizCom Tag Cloud Web Part will be appear under "Virtual Server Gallery":
The section below reviews the Tag Cloud web part's properties and configuration options.
Web Part Properties & Configuration Options The web part's properties are grouped to 3 categories:
Tags List Settings
General Settings
Display Properties
The following sections provide details about each category. 35 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Tags List Settings
You can connect the web part to the tags list of your choice. If you desire, this tool enables you to manage several taxonomies in your organization.
Tags list location – choose the list location from you current site, site collection or a remote site
Select Tags list – this drop down is updated according to the user’s previous selection (in the Tags list location radio buttons). The drop–down displays the tags list available in the selected location.
Select a list view – this drop-down displays the views available for the selected tags list. In Tags Tree mode the selected view will be used to sort and filter the displayed tags. This enables you to define various views to filter the displayed tags/categories according to business needs (show different tags to different employees in your organization).
36 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
General Properties
Various properties are displayed here, according to the selected display mode (tag cloud, tag index, tags tree or tag menu). Also included is the n option to run in advanced search mode to integrate the Tag Cloud or the Tag Tree in the MOSS search results page (more details on this in the next section).
37 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Display Properties
This enables SharePoint developers to fully-customize the web part. The web part’s UI is based on an .ascx (web user control), enabling the interface to be fully customized by .NET developers. 'Display Properties' provides direct access to these user controls.
Tags Cloud Template Url
Tags Index Template Url
Tags Tree Template Url
Tags Menu Template Url
Stylesheet - In this field you can customize the look and feel of the Tag Cloud web part using your own .CSS file. The Tagging Feature uses the following SharePoint styles:
Standard View Styles:
.ms-navitem 38
Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Index View Styles:
.ms-iactionitem
.ms-pagebreadcrumbs
.ms-sitemapdirectional
To create your own style sheet, you will need to create a new .CSS file and to save it in the style library http:///Style Library/enus/Core Styles. To create your own .CSS file, follow the steps below: 1. Create a new .CSS file using the text editor of your choice. 2. Inside the file, be sure to include the styles used by the Tagging Feature (those you wish to change). Example: /* Standard View Styles */ .ms-navItem { color:green; font-family:"Times New Roman", Times, serif; } 3. Once you have your CSS file in place, simply type the custom .CSS file's URL at the top text box (titled "Stylesheet"). For example, if you placed the file in the folder mentioned above, type in the following URL: http:///Style Library/enus/Core Styles /[file_name].css
Errors
In this section you can choose to hide the error messages from the users or to explicitly display errors for debugging purposes. 39 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Tagging Feature Management The tagging feature includes a management interface that enables an organization's knowledge officer to define how the way the feature should be used across the organization. The management interface addresses the following topics:
Tagging Feature general settings
Tagging Feature Tags List
Adding the Tag Field to SharePoint lists/libraries
Deploying the Tag Cloud web part
Integrate the Tagging feature with MOSS advanced search
Export/Import of tags using the Tagging client extensions.
Tagging Feature General Settings In order to configure the general setting of KWizCom's SharePoint Tagging Feature, go to the root level site settings and click on the "KWizCom Tagging Feature Management" link located under "Site Administration Settings". This page allows you to configure the following settings:
40 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Allow users to create new tags lists – checking this checkbox will enable users creating “Tags” list columns, to define a new tags list. If you want all Tags columns to be connected to the same central Tags list – you can disable this option.
Subscriptions – This allows you to define an alert message that will be sent to users who subscribed for alerts regarding a specific Tag. Users can stop receiving alerts clicking the "Unsubscribe" link within the alert message.
41 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Tag Cloud Web Part – Allows you to define minimum font size. This setting is needed when the web part displays many tags which may cause the font size to reduce.
Tags Lists – This table allows you to manage all tags lists available across your sites. Here you can manually add new tags/delete existing tags and manage child-parent relationships between tags (hierarchy).
42 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Managing Tags Lists Tags lists are lists that contain the tags used across all sites. By default, a single Tags list is created at the Site Collection level, allowing you to deploy and manage tagging at the site collection scope. When you manually add a new tag to this list you will need to fill in the following fields:
Title – The current tag's title.
Counter – for new tags inserted manually the value should be 0 (this value affects the tag’s displayed size in the tag cloud). WARNING: Do NOT update tags records manually unless you wish to add new or delete existing records.
Alerts List – List of email addresses of subscribed users.
Parent – defines parent tag of this tag. This is how you define tag hierarchy manually.
43 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Adding the Tag Field to SharePoint lists After completing the installation and activation of the SharePoint Tagging Feature, a new field type will be added to your SharePoint solution. In order to start using the Tagging Feature, you will need to add a new "Tags" column to the lists/libraries that you wish to tag:
44 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
The new field type has several properties you can configure:
Tagging method – Choose "Textual tags" for Web 2.0-style tagging behavior (here users can write tags in a textbox with auto-complete functionality), or "Hierarchical category tree" to provide a "Browse" button enabling users to select categories from a taxonomy hierarchical tree.
Render tags as links limit – if you have a very large amount of tags (thousands), you may want to limit the number of displayed tags, when a user clicks the “Show All” link below the 45
Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Tags field (in Edit/Add mode). We have added this option in order to avoid reduced performance due to exceptional amount of tags.
Allow users to add new tags – Choose "Yes" if you wish to enable users to contribute new tags to the shared taxonomy. Choosing "No" will enable users to use existing tags only.
Source List – you can choose to connect a Tags field to an existing Tags list in various scopes (current site collection, this site, any other remote site), or to create a new Tags list. This means that you can deploy the Tagging feature for crossorganization taxonomy management (where everyone use a central, shared Tags list) AND for local taxonomies (on the department/team level).
Sort & Filter items by view - This field enables defining a required filtering and sorting of the displayed tags/categories in the Tags field.
Integrate the Tagging feature with MOSS search results page KWizCom Tag Cloud web part can integrate with MOSS search results page to apply advanced filtering to your search results - supported in “Tag Cloud” and “Tag Tree” modes. This provides faceted search functionality and can be integrated with the free faceted search add-on for SharePoint, available in codeplex: http://www.codeplex.com/FacetedSearch. Here's how to integrate your SharePoint Tagging Feature with the MOSS 2007 search results page: Step 1: a. b. c. d. e. f.
Go to your Search Center advanced results page Click site settings -> edit page Add “KWizCom Tag Cloud” web part Open the web part properties pop-up Select the tags list you wish to connect to Go to the "General Settings" tab 46
Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
g. In “Display Mode” select “Tag cloud” or “Tag Tree” h. Check the “Run in advanced search mode” checkbox:
i. Under that a new property will appear: “advanced search property name.” Enter the mapped property name you created in your SSP (see step 2 - change only if you changed the value in “2.e”). j. Click ok in the pop-up, and in the web part properties pane, publish your changes to the page and you are done.
Step 2: Configure your SSP Search service to index Tags Fields.
47 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
a. Open your SSP home page: (Central administration -> Shared Services Providers)
b. Click “Search Settings”:
48 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
c. Click “Metadata Property Mappings”:
49 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
d. Select “New Managed Property”:
50 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
e. Set the property name to “TagsFieldForSearch” (if you select a different property name you will have to update it later in the web part). Leave checked the radio button “include values from all crawled properties mapped” and hit the “Add Mapping” button:
51 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
f. Type “tagsfieldfor” and hit the find button. Add all properties to the mapping. You will have to add them one at a time. (* if you cannot see rating fields in the list, make sure you have some rating fields created. If you do have a few rating fields created already you may need to perform a full indexing before you can select them in this window.) g. Once you are done adding all fields, hit OK to confirm the creation of the new managed property. h. You will need to perform full indexing of your SharePoint content sources before changes will take effect. 52 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
KWizCom Tagging Feature Client Extensions The KWizCom Tagging Feature Client Extensions zip file (located in the product "download" page on KWizCom web site) contains the following tools:
TaggingFriend.exe - an example application for client (including source code) that demonstrates how to interface with the Tagging Feature Web Service in order to tag external content.
TagsExportImport.exe – now you can easily import/export tags from/to .CSV files and from WAND* taxonomy XML files, enabling you to deploy taxonomy in just few minutes!
TaggingFriend.exe The SharePoint Tagging Feature includes a Web Service API that enables using the taxonomy management services (tagging, finding content according to requested tag) also from external systems in your organization. The Web Service API is fully described in the "KWizCom Tagging Feature Web Service API – Developer Guide.pdf" document (located in the KWizCom Tagging Feature Client Extensions zip file). TaggingFriend.exe utility enables you to tag any web content (URL) via the Web Service API.
For additional information, please download the KWizCom Tagging Feature Client Extensions.zip file and review the README file.
53 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
TagsExportImport.exe utility This application allows you to rapidly deploy a required taxonomy by importing/exporting tags from/to CSV/XML files.
Import taxonomy from a file into SharePoint Tagging list Importing taxonomy (structure of tags/hierarchical tree of tags) is done in the following stages: 1. Insert the URL of the site which hosts the tags lists you wish to update into the "Tags web url" fields and click the "Load Tags Lists" button. The "Tags list name" drop-down should display the available Tags lists. 2. Select the tags list into which you want to load tags from an external file ("Tags Collection" in the screenshot above). 3. Click the "Load from file" button. Select a CSV/XML* files that contain the tags you wish to import and click "Open":
54 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Note: The CSV and XML files must be in a specific format. The KWizCom Tagging Feature Client Extensions zip file contains 2 sample files: Drinks.csv and Drinks.xml which define the exact structure of the imported files.
4. The content of the selected file will be displayed:
55 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
After you open a tags file its content is displayed in the main text area
5. Click "Update tags list" to update the tags from the imported file into the SharePoint Tagging Feature tags list. Once the import process is finished you will see an "Updated" message box. That's it! Now the imported tags appear in your SharePoint tags list and are ready to be used for tagging and browsing content.
Export existing SharePoint Tagging Feature taxonomy to a file Exporting your existing taxonomy (the content of your SharePoint Tags list/s) to a .CSV file is done in the following stages: 1. Insert the URL of the site which hosts the tags lists you wish to update into the "Tags web url" fields and click the "Load tags lists" button. The "Tags list name" drop-down should display the available Tags lists. 2. Select the tags list from which you want to export tags and click "Load tags from existing list" button:
56 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
3. Click the "Save to file" button, select a new file name and click the "Save" button:
57 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
That's it! Now you have a .csv file with the exported taxonomy. This enables you to move/copy taxonomies between SharePoint servers, or export taxonomy from your SharePoint server to other LOB systems in your organization.
* Remark: Deleting tags is not possible using this tool, which may be done only through the Tagging Feature Administration page, under the Site Administration.
58 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
FAQ Why do Feature?
I
need
the
SharePoint
Tagging
Very simple: When you rely on the SharePoint out of the box Search mechanism it is difficult to find what you're looking for – sometimes you don’t get the needed results, or you can get too many results. This is frustrating and precious work-time is wasted on finding content. SharePoint Tagging Feature enables you retrieve the content you need much faster – no time wasted and no frustration. KWizCom's SharePoint Tagging Feature provides employees with user friendly, effective tools to tag/categorize and retrieve content (documents, articles, tasks or any other piece of content). The immediate outcome is greater productivity, time and money is saved!
Does the Tagging feature support hierarchical category trees? Yes, SharePoint Tagging Feature supports all types of content tagging:
Hierarchical tagging – in this method a central hierarchical taxonomy is managed by authorized users and used by content editors who can select tags/categories with which to tag their content.
Web 2.0 tagging – in this method tags are managed as a flat list of keywords. In the classical Web 2.0 "spirit", all users can contribute to this central tags repository and those tags that are used most will be displayed accordingly by the Tag Cloud (they will appear larger, growing in proportion to their popularity).
Does the Tagging Feature support WSS? Yes. SharePoint Tagging Feature works both with SharePoint Server 2007/WSS 3.0 and SharePoint 2010/SharePoint Foundation.
59 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
How do I create new tags? New tags can be created in various ways:
In Web 2.0-style tagging mode, any user can add new tags using the "Tags" field. These tags are added to the central, shared tags list/s.
The administrator can add tags using the Tagging Feature management page.
You can import tags from .CSV/XML taxonomy files, using the import/export utility included with this feature.
We already have a defined taxonomy; can we import it to SharePoint? Yes you can! SharePoint Tagging Feature includes an import/export utility that enables you to import tags/hierarchical category trees from .CSV and XML files. You can also export the taxonomy from SharePoint to .CSV files, enabling you to move/copy taxonomy lists between servers and systems.
Can we use SharePoint Tagging Feature to implement a central, cross site taxonomy in our company? Yes you can! SharePoint Tagging Feature works in various scopes according to your needs:
Site
Cross site
Cross site collection
Cross system (!!): By providing web service API, you can now tag any web content located in any system in your organization! 60
Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
How do I delete tags? If you have administrative permissions on the site collection - go to the Tagging Feature Settings page under the site collection setting to delete the tag/s.
Do I need to install anything to use the Tagging client extensions? No. The Tagging client extensions consist of execution files which are used simply by running them - no install necessary.
Do I have to install company's client-PCs?
anything
on
my
No. KWizCom SharePoint Tagging Feature is a server installation.
61 Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
Version Release Notes Primary Software Version
3.2.00 (SharePoint 2007) 13.2.00 (SharePoint 2010 beta)
Base version
3.1.00
Release date
March-31-2011 Sub-Modules
Module
Version
n/a
n/a
Version History CR #
Description
Version 3.2.00, 13.2.00 - March-31-2011 110
Support auto-complete for partial word or phrase.
279
Upgrades to SP2010 RTM.
284
Fixed Bug: Tagging feature returning error "There was an error in the callback"
368
Fixed Bug: the tag tree will sometimes show duplicate tags.
374
Add support for using draft versioning.
393
Fixed Bug: After installing Tagging feature or WikiPlus some part of web.config is removed.
486
Fixed Bug: Tagging Feature - Tag index “#” link issue
545
Fixed Bug: Tag hierarchy is not displayed correctly
849
Add indication of the tag’s creator
985
Fixed Bug: Tags with multiple parents are not displayed in the hierarchical view
1145
Propagate tag Renaming to other list items.
1146
Fixed Bug: Creating a tag list in the current site(subsite) does show up in the tag administration menu and in Rename Tag page
1294
Fixed Bug: Customize this page link in Tag Pages List page throws error if in 3rd level subsite
1300
Fixed Bug: Tag Feature does not count properly with a wiki page
1312
Allow administrator to configure tags rendering with no tagged items 62
Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
as links in Tree mode view. 1369
Allow administrator to configure the tag alert email message’s footer.
1389
Fixed Bug: multiple tagging columns used in content types display the same column twice
1421
Allow word wrap for displayed tags in the tag cloud web part.
Version 3.1.00, 13.1.00 - May-15-2010 118
Allow to show additional fields (like description) in tags search results page
124
When hovering over a tag, display the number of tagged items for the current tag
128
Support accessibility standard (WCAG)
130
Enable manual tree sorting
135
Display tag description in Tag page
138
Enable automatic email messages tagging
163
Fixed Bug: Changing a tag in the tag collection list doesn't update in SP list
165
Fixed Bug: If tags list has French name the tags Hierarchical tree returns an error
167
Add taxonomy tree lazy load to support a large amount of tags
168
Create Professional Edition
172
Support tag renaming
181
Enable sorting of the tags tree in the tags field
190
Fixed Bug: Tags showing in autocomplete are not sorted
200
Fixed Bug: installation errors for 64 bit msi
201
Enable using the Tags Field control in any custom page.
202
Enable showing absolute URL instead of relative URLs in search result
203
Fixed Bug: "Customize this page" link on the Tag Pages List page displays 404 error
209
Fixed Bug: "Expand All Nodes" does not work correctly
215
Fixed Bug: There is an overlapping of the text in the search result page in Google Chrome and Firefox browsers
Version 2.4.00, Nov-16-2009 136
Allow RSS subscription per tag
171
Fixed Bug: Spelling mistake in toolpart
173
Performance improvement to support thousands of tags: Load tags in async mode when user click on "Show all" button or type first letter 63
Copyright © 2005-2011 KWizCom corp. All rights reserved. www.KWizCom.com
174
Fixed Bug: String not translated: empty tag list
175
Fixed Bug: All tags are reset to 0 count when deleting a Tags list view in SharePoint Designer.
178
Fixed Bug: Security validation error when trying to create and connect Tags field to local list
179
Fixed Bug: When reconnect Tags field to another Tags list the field data was not removed from "Connected Lists" list
187
Performance improvements – optional tags lazy load in the Tags field to support thousands of tags.
Version 2.3.50, May-15-2009 57
Enabled anonymous users to subscribe on Tags
99
Provided web service interface for tagging external content to SharePoint
100
Support searching the category tree mode web part
114
Support for hierarchy tagging
117
Fixed Bug: Problems with tagging items in a list which has enabled Minor and Major versioning.
127
Integration with MOSS search – faceted search
137
Fixed Bug: Problems with deleting Wiki Plus content type's Tags field from Pages document library in publishing sites
143
Ability to register Tags Web Part only when Tagging feature is activated
144
Fixed Bug: Problem with 2 category tags on the same item
146
Fixed Bug: The tags list are not updating when the "Check out" property is enabled
149
Fixed Bug: problems with tags with "
147 &151
Added tag Importer utility from CSV and WAND file formats
152
Tags hierarchy- "|" is replaced with ">" or "
