Dart KnowledgeWorker™ Client Installation Guide (Version 3.1)

Introduction

This article describes the steps required for installing the Ann-on Components for KnowledgeWorker®. It is essential that the assistance of qualified staff from Ideagen perform a pre install analysis if there are any doubts regarding the configuration.

The KnowledgeWorker® product can be operated as a pure thin client using only the browser. There are however additional components that can be installed to provide the ability for Microsoft Office applications (Word, Excel, PowerPoint and Outlook) to interact with the document management functionality of KnowledgeWorker®.

Pre-Requisites

The hardware requirements are no more than those for the Microsoft Office and the only additional requirements relate to having sufficient hard drive space to unpack and install the add-in components, plus the dependent software components.

It is recommended that there is at least 150 MB for the Add-ins, dependent software and temporary file storage.

Office Integration Add-in for KnowledgeWorker® is provided for the following versions of the Microsoft Office Suite:

• 2000 (SP3)
• 2002 (SP3)

Install Office Integration

The Office Integration functionality is an optional module that consists of an add-in component for Microsoft Office applications (Word, Excel and PowerPoint) and the installation of components on the server side.

IMPORTANT: To use the client Add-in the server side implementation must have been completed as the installation of the client side will need to be configured with data from the server side.

The installation of Office Integration on the client machines requires:

• A setup routine to be run for the relevant Microsoft Office version on the client
• The configuration of the preferences within the Office Integration Add-in for each user

The Office integration client setup is provided for:

• Microsoft Office 2000 SP3
• Microsoft XP (2002 SP3).

NOTE: It is not recommended that a client machine have both the previous office integration macros (Version 3.0) and the office integration add-in (Version 3.1) installed concurrently. Please remove the previous office integration macros by closing all Microsoft Office applications on the client and deleting / moving the macro files from the start-up directories. For outlook, the functionality should be removed using Add / Remove Programs from the control panel.

Setup on Client

The setup on the client requires that the user conducting the installation has the right to install applications. Typically in many organisations this is now restricted to an administrative user.

To install the client software:

1.  Login as user with the appropriate rights and privileges to install an application

2.  Make sure that all applications are closed on the client machine, alternatively reboot the client machine and start the setup for the relevant version of Microsoft Office.

3. Run the Setup program:

• For Microsoft Office 2000 clients this can be found in CD\OFFICE_KWORKER\KWOFFICE\Setup Office 2000
• For Microsoft Office XP (2002) clients this can be found in CD\OFFICE_KWORKER\KWOFFICE\Setup Office 2002

Configuration on the Client

The configuration of the client involves launching one of the supported Microsoft Office applications (Word, Excel or PowerPoint) and setting the preferences. These preferences can be changed by the user at any time but it is recommended that the publish dialogue is closed and re opened before the settings are used.

The preferences for each user are saved into the registry key for the current user so that these can be recalled for subsequent uses of the Add-in.

Selecting Publish to KnowledgeWorker from the toolbar will cause the user to be prompted with a login screen and by selecting the Settings button the user will be able to define the configuration settings for themselves.

Note: If this bar does not appear then right click in a blank space on the menu bar and select the option to activate the bar, because it has been deactivated for your profile.

The Settings dialogue is illustrated below.

Web URL is the means by which the Office Integration client can communicate with the application server and represents the URL address required to connect to the KWOffice virtual directory. This should be supplied to you by the system administrator.

User Name is the login name normally used to access a repository. You must have an active login to a repository to use the add-in.

Server name is the repository to which the user wishes to connect.

Max Results determines the number of entries that are returned at once when navigating large folder structures.

Temp Path is the local location on the client machine into which the background file saves will be placed prior to being transferred to the application server and the repository.

Note that only the Publish to KnowledgeWorker tool option is used normally. The remaining toolbar options are to support document generation from a workflow instance and the ability to save and version the generated documents to the task.

Important:

• Where the client application is being installed on the application server then it is important that the temporary directory / path is different for the Office Integration Add-in to that used for the application, else the two applications will suffer from contention.
• The web URL must point to the appropriate version of the KWOffice virtual directory that is delivered with Version 3.1. If a previous installation of the KWOffice virtual directory exists (V3.0) then it can run concurrently but only one web URL can be supported per client, which must be the appropriate address for the installed client software.

For a detailed description of the functionality of Office Integration, please refer to the Office Integration User Guide for V3.1.

Install Outlook Integration

The Outlook Integration functionality is an optional module that consists of an add-in component for Microsoft Outlook and the KnowledgeWorker® application server.

The Outlook Integration on the client side consists of an Add-in component that stores the settings and a temporary PST file on the client machine. The settings file holds the user credentials for the user, including password and the links to communicate with the server.

The installation of Outlook Integration on the client machines requires:

• Installation of the SOAP Toolkit 3.0
• A setup routine to be run for the relevant Microsoft Outlook version on the client
• The configuration of the settings in Outlook for each of the client machine

The outlook integration client setup is provided for:

• Microsoft Outlook 2000 SP3
• Microsoft XP (2002 SP3)

Setup on Client

The setup on the client requires that the user conducting the installation has the right to install applications. Typically in many organisations this is now restricted to an administrative user.

To install the client software:

1. Login as user with the appropriate rights and privileges to install an application.
2. Make sure that all applications are closed on the client machine, alternatively reboot the client machine and start the setup for the relevant version of Microsoft Outlook.
3. Run the Setup:

For Microsoft Outlook 2000 clients this can be found in CD\OFFICE_KWORKER\OUTLOOK_KWORKER\Setup OutLook 2000
For Microsoft Outlook XP (2002) clients this can be found in CD\OFFICE_KWORKER\OUTLOOK_KWORKER\Setup OutLook 2002

Configuration on the Client

The configuration of the client involves launching Microsoft Outlook and providing the setting information. The settings dialogue is illustrated below.

The URL field is the means by which the pages within interface will be displayed and relates to the URL that would be normally used to launch the KnowledgeWorker® interface (minus the asp page).

The WSDL-Path is the means by which the Outlook Integration client can communicate with the application server and represents the URL address required to connect to the OutlookWSDL virtual directory.

Both the URL and WSDL-Path fields would typically be populated with data supplied by the system administrator.
The Server is the repository to which the user wishes to connect.

The User is the login name normally used by the user to access the repository. You must have an active login to a repository to use the add-in.

The Password is the password normally used by the user to access the repository.

The Language is the language that would normally be used in the interface and determines the language presented in the pages from the repository, it does not influence the language of the standard Microsoft Outlook dialogues.

The Upload Path is the local location in the client machine into which the background files will be placed prior to being transferred to the application server.

Important: Where the client application is being installed on the application server it is important that the temporary directory is different for the Outlook Integration Add-in to that used for the application, else the two applications will suffer from contention.

To save the settings press OK and the settings will be given a simple test.

If the settings are correct and pass the connection test, the user will be prompted to shutdown and re-open Microsoft Outlook.

Any errors that are detected will be presented to the user with a warning message and the settings will not be saved. The user must correct the problem before pressing OK to test the settings again. The basic checks made on the settings are:

• User name
• Password
• Server / repository name

These settings can be changed by the user at any time but Outlook must be closed and re-opened before the new settings are used.

Note: The closure of Outlook will destroy the temporary PST file that is created and create a new one upon opening. The user privileges and permissions must permit this behaviour for the successful deployment of the Outlook Integration.

For a further detailed description of the functionality of the Outlook Integration, please refer to the Outlook Integration User Guide for V3.1.