SourceForge.net Logo

Documentation

Currently the documentation is informal. Formal user documentation will be forthcoming. For now this page will serve as a quick guide to getting KnowledgeOffice up and running.

The following documentation is available:

Change Logs

System Requirements

  • .NET Redistributable (1.1) - The .NET redistributable (framework version 1.1) must be installed on any machine wanting to run KnowledgeOffice (server or client).
  • KnowledgeTree - KnowledgeTree must be up, running and accessible

ByteFX


ByteFX have developed an Open Source data provider libary that "is a 100% managed, high-performance library of data providers for use in .NET environments". It currently supports MySql 3.23.x and MySql4.

It is used by the KnowledgeOffice server, so make sure you install it on the machine hosting the KnowledgeOffice Server (this library is NOT required by the clients) before you attempt to install KnowledgeOffice. If you don't, KnowledgeOffice WILL NOT WORK.

Click here to go to the download page.

Server installation

The server must be run as a Windows Service. Currently the server has an installer which installs the files, but adding it as a service to Windows must be done manually.

NOTE
  • If you didn't read the section entitled "ByteFX" (above), please do so first. It contains links to software (Open Source) that you need to run KnowledgeOffice
  • KnowledgeOffice MUST be installed on the machine hosting the KnowledgeTree documents
  • If you have a firewall running, you will need to give KnowledgeOffice permission to use the port you wish it to run on (see steps 3 & 6 below)
  1. Make sure you have the .NET framework installed on your maching
  2. Run the MSI Installer (or Setup.exe) found in the server binary download
  3. Edit KnowledgeOfficeServer.exe.config (found in the installation directory you chose during the install process) and change
    • the 'connectionString' value to match those for your KnowledgeTree MySql database
    • the 'documentRoot' value to match the document root for your KnowledgeTree documents
    • the 'serverURL' value to match the external IP (the IP other machines on the network use to connect to your server maching) of the matchine it is running on
    • the 'serverPort' value to the port number you want the KnowledgeOfficerServer to run on
    • make sure the 'debug' value is "false"
  4. Run the .NET framework services install utility, installutil from the directory into which the copied the KnowledgeOffice files like so: installutil KnowledgeOfficeServer.exe
  5. Be sure to let the KnowledgeOffice server run as a user that has sufficient permission to write to the KnowledgeTree document folderr
  6. If you have a firewall, make sure that the KnowledgeOfficeServer has permission to connect to the specified port and to receive incoming connections

Server usage

Once the service is installed, start it through the Windows Service Management Console.

You can make sure the server is running correctly by open a command console and typing in "netstat -an -p TCP". You should see the IP and port you chose to run the KnolwedgeOffice server on as one of the entries in the list.

Client installation

  1. Ensure you have both KnowledgeTree and KnowledgeOfficeServer installed on a server on your LAN and that the KnowledgeOffice server is running
  2. Run the Window's Installer
  3. Close down and restart all Microsoft Office products. A new button, labeled 'KnowledgeOffice' will appear on the main toolbar
  4. Clicking on this button the first time will present you with a settings dialog that requests certain information
    • Username: your KnowlegeTree username
    • Password: your KnowledgeTree password
    • Server URL: the IP address on which the KnowledgeOffice server is running
    • Server port: the port on the machine on which KnowledgeOFfice is running to connect to

Client usage

Once KnowledgeOffice is installed and the required information has been entered, the KnowledgeOffice button will become context sensitive. The button works in the following way:

  • Check-out of a new document - If you have a documemnt open that is NOT saved or SAVED UNDER A DEFAULT OFFICE NAME (such as Document1 or Book1), you will only be able to check a document out from KnowledgeTree
    • Adding a document to KnowledgeTree - If you have a document open that is saved under a name other than a default Office name, but is not under KnowledgeOffice management, clicking on the KnowledgeOffice button will allow you to add it to KnowledgeTree. During the add process, you will be asked to enter the required meta-data information, as per normal KnowledgeTree usage. Note that once you have added a document to KnowledgeTree using KnowledgeOffice, you will need to check it out from KnowledgeTree using KnolwedgeOffce before it will come under KnolwedgeOffice management.
  • Check-out - If you have a document open that is under KnowledgeOffice management and is checked-in, clicking on the KnowledgeOffice button will allow you to check it out
  • Check-in - If you have a document that is open, under KnowledgeOffice management and checked-out, clicking on the KnowledgeOffice button will allow you to check it out

The following additional functionality also exists
  • Check-in reminder - If you are working on a document under KnowledgeOffice management that is checked-out and you close the Office application, you will be prompted to check the document in
  • Check-out reminder - If you open a document that is under KnowledgeOffice management that is checked-in, you will be prompted to check it out