Installation Instructions: KnowledgeTree Office Add-in 1.0.0 RC2

From KnowledgeTree Document Management Made Simple

1 Introduction
2 System Requirements
3 Installing KnowledgeTree Office Add-in 1.0.0 RC2
4 Troubleshooting
5 Documentation

Introduction

This procedure installs KnowledgeTree Office Add-in 1.0.0 RC2.

NOTE: The KnowledgeTree Office Add-in 1.0.0 RC2 install package comprises two zipped files:

1. KTOffice_Addin_1.0.0_RC2_Patch.zip

Includes the following server patches:
ktapi/ktapi.inc.php
ktapi/KTAPIDocument.inc.php
ktapi/KTAPIFolder.inc.php
ktapi/KTAPIAcl.inc.php
templates/ktcore/ktoffice_i18n.smarty
officeaddin
extjs
ktoffice

2. KTOffice_Addin_1.0.0_RC2.zip - the KnowledgeTree Client Tool

IMPORTANT: You must install the server patches provided to allow the Add-in client tool to function correctly.

[edit]

System Requirements

KnowledgeTree Server

KnowledgeTree Commercial Edition 3.5.4a (Windows or Linux)
A valid KnowledgeTree Commercial License, installed

Clients

Microsoft Windows Vista (SP1) or XP (SP3) 32-bit or 64-bit
Microsoft Office 2007

IMPORTANT: We recommend uninstalling KnowledgeTree Tools before testing KnowledgeTree Office Add-in 1.0.0 RC2.

[edit]

Installing KnowledgeTree Office Add-in 1.0.0 RC2

[edit]

Step 1: Download KnowledgeTree Office Add-in 1.0.0 RC2

NOTE: The server patches and the KnowledgeTree Office Add-in client component are available for download on the  
KnowledgeTree Commercial Download page.

[edit]

Step 2: Installing the Server Patches

Perform the following steps on the KnowledgeTree Server:

2.1 Extract the content of the server patch archives (zipped files) into the KnowledgeTree Installation Directory as follows:

Windows default: 
C:\Program files\ktdms\

Linux default:
/home/<user>/ktdms or /opt/ktdms (root installations)

NOTE ON BACKUPS: Several of the server patch files replace existing files and folders in the KnowledgeTree directory. As a precautionary measure, you may want to back up the relevant files and folders before copying the patch files to the directory. You can create a backup by making a copy of the relevant folder, then renaming the copy by appending .BAK to the folder name, e.g. At \\ktdms\knowledgeTree\ktapi\ make a copy of the ktapi folder, then, rename the copy to ktapi.BAK.

2.1.1 Copy the following extracted files to the ktapi folder at \\ktdms\knowledgeTree\ktapi\:

ktapi.inc.php
KTAPIAcl.inc.php
KTAPIDocument.inc.php
KTAPIFolder.inc.php

2.1.2 Copy the following extracted folders and files to the KnowledgeTree directory as follows:

officeaddin folder - copy to: \\ktdms\knowledgeTree\plugins\
extjs folder - copy to: \\ktdms\knowledgeTree\thirdpartyjs\
ktoffice folder - copy to: \\ktdms\knowledgeTree\
ktoffice_i18n.smarty file - copy to: \\ktdms\knowledgeTree\templates\ktcore\

NOTE on Permissions for Linux Users: To ensure that you can still access the directory files that will be  
   replaced by the server patches, ensure that permissions are set correctly on these files after they are 
   copied to the directory (Ensure that 'Folder Access' is set to 'Access Files' for Groups and Others)

2.2 Configure the KnowledgeTree server:

2.2.1 Read and enable the Office Add-in plugin through KnowledgeTree's Web interface.

To do this ...

Use your admin credentials to log in to KnowledgeTree's Web interface; then, go to DMS Administration - Miscellaneous - Manage Plugins.
Re-read the plugins; then, enable the Office Add-in plugin. Save your changes.

2.2.2 Configure client policies for KnowledgeTree Office Add-in.

To do this ...

Go to DMS Administration - System Configuration - Office Add-in; then, on the Office Add-in Settings page, define policies for all KnowledgeTree Office Add-in users in your organization.
When you're done, click Save Config Settings.

[edit]

Step 3: Run the Pre-Install Checkup

The pre-install checkup verifies that your system is ready to support the successful installation and operation of the KnowledgeTree Office Add-in.

3.1 To run the pre-install checkup, open your Internet browser; then, go to: http(s)://<Your Server Address>/ktoffice/setup

3.2 View the results of the checkup. Items in 'green' text pass the check; items in 'red' text fail the check. Correct the necessary items (if any).

What information is included in the system checkup?
KnowledgeTree Server Settings:
* KnowledgeTree server directory
* KnowledgeTree server URL
* KnowledgeTree server version
* Whether the KnowledgeTree patches are installed (Yes/No)
Commercial License Settings:
* Whether a KnowledgeTree license is installed (Yes/No)
* KnowledgeTree Commercial license type 
* Number of KnowledgeTree users allowed for your KnowledgeTree license
* KnowledgeTree license expiry (expiry date, and number of days to expiry)
KnowledgeTree Path Settings:
* Whether the following locations are 'writable': Log directory, Document directory, Webservice uploads directory.

[edit]

Step 4: Install the KnowledgeTree Office Add-in Client Tool

Perform the following steps on each client machine requiring access to the KnowledgeTree server through Microsoft Office 2007:

4.1 Ensure that all Microsoft Applications are shut down.

4.2 Extract the client tool from ktoffice_addin_setup.zip to the desktop; then, run Setup.exe, and follow the instructions in the Install wizard.

4.3 When setup completes, open either Word, PowerPoint, or Excel. The KnowledgeTree Office Add-in panel displays on your screen.

4.4 In the KnowledgeTree ... Server dialog box, enter the connection details for the KnowledgeTree server, e.g. http://.. or https://.. (for secure connections); then, click OK.

Note: Provide a server address with the following format:  e.g. 
'http://myserver/' or 'https://myserver/'.  And provide your server's port number after a colon if your server 
is not using a standard HTTP or HTTPS port, e.g: 'http://myserver:8080/

4.5 When the connection to KnowledgeTree is successfully established, the Login page displays. Log on to KnowledgeTree, using your KnowledgeTree username and your KnowledgeTree password. KnowledgeTree's Browse view folder tree displays in the panel.

[edit]

Troubleshooting

Read the KnowledgeTree Office Add-in 1.0 RC2 [1] for more information on the KnowledgeTree Office Add-in, including known issues and potential workarounds.

[edit]

Documentation

The KnowledgeTree Office Add-in Quick Start Guide contains full instructions (with screenshots) for installing and working with the KnowledgeTree Office Add-in.