Installation & User Guide

SharePoint Dual Lookup Field Type Installation & User Guide Copyright © 2005 KWizCom LTD. All rights reserved. Company Headquarters P.O. Box #3851...
Author: Jacob Welch
7 downloads 0 Views 715KB Size
SharePoint Dual Lookup Field Type

Installation & User Guide

Copyright © 2005 KWizCom LTD. All rights reserved.

Company Headquarters P.O. Box #38514 North York, Ontario M2K 2Y5 Canada E-mail: [email protected] Web site: http://www.KWizCom.com Sales E-mail: [email protected] Telephone: +1-905-370-0333

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

Table of Contents Introduction ............................................................................................... 4 Overview ...................................................................................................... 5 Adding Dual Lookup Field Type column________________________________ 7 Working with the Dual Lookup Field _________________________________ 10 Key Features & Benefits _____________________________________________ 14

Installation ............................................................................................... 15 Software prerequisites ______________________________________________ 15 Installation Procedure ______________________________________________ 15

Component Localization ....................................................................... 16 Resource File Editor utility structure ________________________________ 16 Translating a KWizCom component _________________________________ 17 Use the component in your preferred language _____________________ 18

Component Activation .......................................................................... 19 FAQ............................................................................................................... 21 Do I have to install anything on my company's client-PCs? __________ What advantage does this field has comparing to 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? _____________________________

21 21 21 21

Version Release Notes .......................................................................... 22 Version History _____________________________________________________ 22 This Version's Known Issues/Limitations ___________________________ 22

Technical Support ................................................................................... 23

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

Introduction KWizCom SharePoint Dual Lookup Field is a new SharePoint field type that enhances the capability of connecting various entities (list items) in SharePoint.

KWizCom SharePoint Dual Lookup Field supports MOSS 2007 / WSS 3.0.

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

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

Overview KWizCom SharePoint Dual Lookup Field enables you to: 1. Automatically create a two-way connection between different libraries / lists. This enables you to easily navigate from one item to all the items connected to it from different libraries/lists. For example: when you create a dual lookup field in “Orders” list that connects each order to a customer in “Customers” list, a reverse lookup will automatically be created in the customers list.

This enables you to easily manage all customer’s orders directly from the customer’s “view item” page as demonstrated in the following screenshot:

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

2. Create a filtered lookup which allows the displaying of a filtered list of the items in the target list, according to a defined view, from the lookup field For example: when a sales agent creates a new order item, we wish that he’ll be able to pick a customer from a lookup field (which will be connected to “Customers” list). We wouldn’t want to present ALL of the customers list, but only a filtered list of managed customers. This can now be easily implemented by defining a view “My Customers” in the “Customers” list, and by creating a “Customer” dual lookup field in the “Orders” list that connects to the “Customers” list through the “My Customers” view. 3. Create cross site lookup which allows you to connect not only to a list in the current site but also to any list/library in the entire site collection.

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

Adding Dual Lookup Field Type column After you install the product on the SharePoint server a new “Dual Lookup” field type will be available in the “Add Column” list page:

The “Dual Lookup” field type has several properties you can configure:

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



Get information from site– choose between the current site (default), the site collection (most top level site) or in the following site meaning a specific site in the current site collection, which you specify in the text box and press Load.



Get information from list- choose the list or library to get the required information from.



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- choose the view from the list or library you wish to use for filtering the displayed items in the lookup field.



Use this view to filter the displayed connected items in the item’s “view properties” page – If you check this checkbox, the table that displays all connected items from the target list, will be also filtered by the chosen view in the “Filter items by this view” field.

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



Allow multiple value- Check this checkbox if you want this to be a multi-select lookup field.



Display connected items detailed table in the item’s “view properties” page- in order to display a detailed table with information about the connected items in the item’s “view properties” page, check this checkbox.



Columns for detailed table- choose the columns that will be displayed in the detailed table showing the information about the items from the target list or library.



Create a reverse lookup field in the target list – Check this checkbox in order to create the a lookup field in the target list that connects it to the current list.



Column name – The name of the lookup column that will be created in the target list.



Display data from the current list’s column- Select the column in the current list that the created lookup column on the target list will be connected to.

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



Filter item by this view- choose a view that wil be used to filter the content of the created lookup column in the target list.



Use this view to filter the displayed connected items in the item’s “view properties” page - If you check this checkbox, the table that displays all connected items from the current list, will be also filtered by the chosen view in the “Filter items by this view” field.



Allow multiple value- in order to allow multiple values in the field check the checkbox.



Display connected items detailed table in the item’s “view properties” page – in order to display a detailed table with information about the connected items in the item’s “view properties” page, check this checkbox.



Columns for detailed table- choose the columns that will be displayed in the detailed table showing the information about the items from the current list or library.

Working with the Dual Lookup Field After adding the Dual Lookup column, you can start connecting information to lists’ items. When you add (or edit) an item you will see the new property you created:

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

You can choose the relevant information From the Dual lookup column. Once your items are connected to a list items, the items you chose will be shown as links in the target list:

You can click on the link of any item in the Customers column (the dual lookup field) to see its details in the connected list.

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

You can of course connect several lists to a target list, so in this example, you can show for each customer all his orders, related invoices, support calls etc. By clicking the “Create new item” link bellow the connected orders table, a new order form will be displayed, with the current customer selected in the “Customer” lookup field:

This means that the current context is kept (in this example: the customer), and you create all related items (orders, support calls etc.) – directly from the customer’s properties view page. 12 Copyright © 2005 KWizCom Ltd. All rights reserved. www.kwizcom.com

Important: When connecting a document library to the dual lookup field, make sure that the Title field in the library is also filled and not only the Name field, so that the document’s titles will be displayed in the dual lookup field.

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

Key Features & Benefits Feature

Support MOSS 2007 / WSS 3.0 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

Dual

WSS/MOSS

lookup

Lookup

field type

field





 

target list Enables the creation of lookup field to lists that are located on different sites. Creates a “CRM-like” interface: On every item’s “View Properites” page, you can display all its

 

connected items in a grid display.

14 Copyright © 2005 KWizCom Ltd. 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 Microsoft Internet Explorer 7

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!

15 Copyright © 2005 KWizCom Ltd. 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

16 Copyright © 2005 KWizCom Ltd. 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.

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

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

18 Copyright © 2005 KWizCom Ltd. 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.

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

3. Get the component activation key – this key will be sent to you by email once your order is processed. 4. Activate your installed evaluation version click Start -> All Programs -> KWizCom -> SharePoint Dual Lookup Field ->

Activate SharePoint Dual Lookup Field Type

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

FAQ Do I have to install anything on my company's client-PCs? No. KWizCom SharePoint Dual Lookup Field Type is a server installation.

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.

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

Version Release Notes Primary Software Version

1.2.00

Base version

n/a

Release date

January-28-07 Sub-Modules

Module

Version

n/a

n/a

Version History CR #

Description

This Version's Known Issues/Limitations CR #

Description

22 Copyright © 2005 KWizCom Ltd. 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 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.

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 KWizCom Ltd. All rights reserved. www.kwizcom.com