SharePoint Cascading Lookup Plus
Field Type
Installation & User Guide
Copyright © 2005-2008 KWizCom Corporation. All rights reserved.
Company Headquarters
KWizCom
148 Castle Rock Dr.
Richmond Hill, Ontario
L4C 5K5, Canada
E-mail: [email protected]
Web site: http://www.KWizCom.com
Sales
E-mail: [email protected]
Telephone: +1-905-370-0333
2
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
Table of Contents
Introduction ...................................................................................................... 4
Overview ........................................................................................................... 5
Key Features & Benefits _____________________________________________________ 8
Installation ........................................................................................................ 9
Software prerequisites ______________________________________________________ 9
Installation Procedure ______________________________________________________ 9
Component Localization ................................................................................... 10
Resource File Editor utility structure ___________________________________________ 10
Translating a KWizCom component ____________________________________________ 11
Use the component in your preferred language ___________________________________ 12
Component Activation...................................................................................... 13
Administration Guide ....................................................................................... 15
General ________________________________________________________________ 15
This column settings _______________________________________________________ 17
Target column settings _____________________________________________________ 20
FAQ................................................................................................................. 21
What advantage does this field offer in comparison with the SharePoint Lookup field? _____
Can I use only the filtering or cross site features of the Dual Lookup Field Type? ___________
Does this field support WSS and MOSS? ________________________________________
Do I have to install anything on my company's client-PCs? ___________________________
21
21
21
21
Version Release Notes ...................................................................................... 21
Version History __________________________________________________________ 22
Technical Support ............................................................................................ 23
3
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
Introduction
KWizCom Cascading Lookup Plus Field Type is a new SharePoint field type that enhances
the capability of lookup fields in SharePoint and provides a cascading, cross-site, 2-way
lookup field.
KWizCom SharePoint Dual Lookup Field supports MOSS 2007 / WSS 3.0.
This document provides all the information you need to install, evaluate and deploy this
KWizCom product:

Product overview

Installation guide

Component activation

Administrator guide

FAQ

Version release notes
4
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
Overview
Super-Lookup field, allowing you to easily implement real, sophisticated, crosssite, relational-database solutions in SharePoint!
The new SharePoint Cascading Lookup Plus Field type (previously called 'Dual Lookup') is a new
lookup field type that includes ALL missing features sharepoint implementers were looking
for in SharePoint Lookup fields.
With SharePoint Cascading Lookup Plus Field you can:
Create a cascading fields
Easily filter field values by other fields in the same List.
Example: Want to display "Region", "Country" and "City" fields, where each one filters the
next field?
With the SharePoint Cascading Lookup Plus Field type you can do it in just 1 minute!
Create a two-way connection between lists
5
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
By Using this feature you finally can implement a true relational model (yes – just like in
"normal" database applications!).
The SharePoint Cascading Lookup Plus field enables you to create "dual lookup" field,
meaning: when you create a lookup from one list to another, a reverse lookup is
automatically created.
For example: when you create a lookup field in “Orders” list that connects each order to a
customer in “Customers” list (see below) a reverse lookup will automatically be created in
the customers list.
So, how does this help you?
6
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
Now you can easily manage all customer’s orders directly from the customer’s “view item”
page as demonstrated in the following screenshot:
You can manage a connection between any 2 entities from either side of the relationships –
just like in any regular relational application!
7
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
Key Features & Benefits
Feature
KWizCom
WSS/MOSS
Lookup Plus
Lookup field
field
Compatible with MOSS 2007 / WSS 3.0
Support Cascading fields ("City" filtered by "Country")
Automatically creates a bi-directional connection between
items
Enables the filtering of the displayed items in the lookup field
according to a view defined in the target list
Cross site lookup - enables the creation of lookup field for
lists that are located on different sites.
Creates a “CRM-like” interface-on every item’s “View
Properites” page, you can display all the connected items in a







grid display.
Allow the conversion of lookup fields to KWizCom Lookup
Plus fields
Enable paging, filtering and sorting
Enable changing a field from single to multiple value
Creating new item using Create new item link




Cross-Browser support

Multi-lingual (like all KWizCom components)


8
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
Installation
Software prerequisites
Server Requirements
1. Microsoft Windows SharePoint Services 3.0 (WSS 3.0)
Or
2. Microsoft Office SharePoint Server 2007 (MOSS 2007)
Client PC Requirements
1. Microsoft Windows XP (SP2) or Windows Vista
2. Microsoft Internet Explorer 6 + or Mozilla Firefox 3.0.1+
Installation Procedure
1. Log in as local administrator to your SharePoint server.
2. Unzip the KWizCom SharePoint Dual Lookup installation zipped file on your WSS 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.
4. That's it! Your Dual Lookup Field Type is installed!
IMPORTANT:
If you are upgrading an existing "Dual Lookup" installation, then after you complete the
installation you should run the installation once again and perform a "repair" operation.
9
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
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.
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
10
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
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->SharePoint Dual Lookup Field Type->
Dual Lookup
Field Type 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.
11
Copyright © 2005-2008 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).
12
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
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. Send us the installed evaluation version's product Code (you will see the product
Code on the "About" product page:
Please use the Activation Request web form, on KWizCom web site to send us your
product code.
3. Get the component activation key – this key will be sent to you by email once your
order is processed.
13
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
4. Activate your installed evaluation version click Start -> All Programs -> KWizCom -> SharePoint Cascading Lookup Plus Field ->
Activate SharePoint Cascading Lookup Plus Field Type
14
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
Administration Guide
General
After you install the product on the SharePoint server a new “Cascading Lookup Plus” field
type will be available in the “Add Column” list page:
Once you create a Cascading Lookup Plus column, you basically have to define 3 things:

The lookup list from which this field should pull its values from
This can be a list/library located in same saite or another site.

Master field that this field should be filtered by (Optional)
This enables you to provide cascading bahaviour (such as "City" drop-down filed
which is filtered by a "Country" field in the same list)

The reverese lookup field that will be created in the lookup list (Optional)
You can define a bi-directional connection between the current list and the lookup
list.
For example: when you create a cascading lookup plus field in "Orders" list and
connect this field to a "Customers" list, you can define that in the "Customers" list a
15
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
reverse lookup will be created to the "Orders" list.
As a result of this dual-lookups users will be able to see in every Customer View/Edit
form all the connected orders for the customer.
The following chapter describes the various field's properties that enable you to configure
these settings.
16
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
This column settings
Property
Function
Get information from site
Define where the Lookup list is located:

Site collection level

This site

Other site in the same site collection
Get information from list
Select the Lookup list (like in a regular SharePoint Lookup field)
In this column
Choose the name of the column you wish to get information from and
display in the lookup field.
Filter item by this view
Select the view from the Lookup list that you wish to use for filtering the
17
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
Property
Function
displayed items in the lookup field.
This feature enables you to provide filtered lookups. Example: When a
ssalesman adds a new Order to the orders list, the "Customer" lookup field
may show him a drop-down listing only his customers ( ather than all
customers in the lookup "Customers" list)
Use this view to filter the
displayed connected items
in the item’s “view
properties” page
If you check this checkbox, the defined view above will be used in the
Open link in a new window
If checked, then whenever a user clicks a lookup value link, it will open the
item's View page to filter lookup values from the lookup list.
item's View form in a new browser window.
Allow multiple values
Unchecked means that it is a single-value lookup that willpoint to a single
item in the lookp list. In this case the field will be displayed using a dropdown control in edit mode (Same as the regular SharePoint lookup field).
Checking this field will make it a multi-value lookup list that will be
rendered as a grid (table) of lookup values.
Example: If you create a lookup field in "Employees" list to a "Tasks" list,
you may want to make it a multiple-value lookup field because an
employee may have many tasks ( when you browse an employee's View
form, you will see a grid containing all his/her tasks)
Skin
Choose al layout of the drop-down field (relevant only for Single-value
lookup).
The "Classic" skin displays the default drop-down with white background.
REMARK:
For Right-to-left languages (RTL), the "RTL" skin will display the classic
drop-down.
Columns
Select the columns from the lookup list that will be displayed in the item's
View form.
Explanation:
Unlike the regular SharePoint lookup list where you can display only a
single column from the lookup list, here you can display several columns –
all displayed as a grid in the item's View form.
Allow filter on columns level
for detail table
This is relevant exclusively for multiple lookup field.
Checking this property will enable users to filter the grid showing the
lookup lists columns.
Edit column value by
This is relevant only for multiple lookup field.
18
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
Property
Function
request
This enables users to edit a lookup item from the current list item. Example:
Looking at a specific customer View page, user can edit one of the
connected orders.
Allow paging, Page size
This is relevant only for multiple lookup field.
Define paging functionality for the displayed lookup items.
Enable master detail
Check this property if you wish this field to be filtered by another field on
the same list (such as "City" field that you want to be filtered by a
"Country" field in this list)
Master column in current
list
Filter by column in lookup
list
Choose the filtering field (the "country" field in this example).
Choose the field in the lookup list (remember? This column connects to a
lookup list) that should be compared to the master field in order to filter
the displayed values.
In our Contry-City example, the "City" lookup field connects to a "Cities" list
that should have a "Country' field which will be compared to a master
"Country" field.
19
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
Target column settings
If you want a reverse lookup field created in the Lookup list, check the "Create a reverse
lookup field in the target list".
This will enable you to define for the remote lookup field the same settings as you defined
for the current lookup field .
That's it!
These settings enable you to create all sorts of relations between entities (lists), located in
same/different sites:

1 to many – such as Customer to Invoices

1 to 1 – such as Partnet to Contract (assuming you have a single contract with every
partner)

Many to many – such as Class to Student
20
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
FAQ
What advantage does this field offer in comparison with the
SharePoint Lookup field?
KWizCom SharePoint Dual Lookup Field is a new SharePoint field type that enhances the
capability of connecting between various entities (list items) in SharePoint by automatically
creating a two-way connection, allowing filtered lookup and cross site lookup.
Can I use only the filtering or cross site features of the Dual
Lookup Field Type?
Yes. You can choose which features you wish to use with the KWizCom SharePoint Dual
Lookup Field Type, simply by clearing the check box for every feature you don’t want to
use.
Does this field support WSS and MOSS?
Yes. KWizCom SharePoint Dual Lookup Field Type supports both WSS and MOSS.
Do I have to install anything on my company's client-PCs?
No. KWizCom SharePoint Dual Lookup Field Type is a server installation.
Version Release Notes
Primary Software
Version
2.2.00
Base version
1.2.00
21
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
Release date
Nove-22-08
Sub-Modules
Module
Version
n/a
n/a
Version History
CR #
Description
Version 2.2.00, November-22-2008
40
Allow/convert lookup to Cascading Lookup Plus field
41
Improve user interface, enable: paging, filtering, sorting in edit mode
42
Implement cascading fields
43
Enable changing a field from single to multiple value
44
Add "Add" link in edit page to create a new linked item
45
Creating new item using Create new item link
47
Fixed bug: Conversion from Lookup to Dual lookup creates multiple fields with the same
name
48
Fixed bug: Master detailed error
51
Fixed bug: When adding a new lookup item from "Edit" page - the item is NOT added as
lookup
52
Support site columns
57
Fixed Bug: If I do not choose any lookup columns to display - the lookup grid displays
empty columns
58
Fixed Bug: When "Create a reverse lookup field.." checkbox is un-selected not all sub
controls are disabled
67
Add "Clear" link to enable users clear the selected lookup items.
68
Fixed Bug: Alignment issues with RTL languages
72
Fixed Bug: Error when lookup value has ; in it
77
Enable users to choose to open links in same window or in a new window
78
Fixed Bug: "Display this column using" is not sorted
79
Fixed Bug: Child control of the reverse lookup checkbox is still active after unchecking
the "Create reverse lookup" checkbox
82
Change default field mode to "single select" that displays a drop-down
84
Fixed Bug: Cascading doesn't work in Firefox
22
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com
Technical Support
You can obtain technical support using any of the following methods:
The KWizCom Web site
The KWizCom website: www.KWizCom.com contains
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.
23
Copyright © 2005-2008 KWizCom corp. All rights reserved. www.kwizcom.com