Word Add-in 6.1.x
Word Add-in enables users to upload new files and edit existing OpenKM files.
When a user uploads new files, they browse the OpenKM tree view to select where they want to upload the file.
The OpenKM Word Add-in detects if the document opened by a user is an OpenKM file and enables or disables some toolbar options.
Office Add-ins are compatible from version 2000 to version 2019.
After installing the Outlook add-in, a new menu item "OpenKM" will appear in Outlook.
Details of the functions according to their icons:
| Button | Action |
|---|---|
|
Add-in configuration. |
|
|
Add new document. |
|
|
Document edit (check-out) |
|
|
Upload modified document (check-in) |
|
|
Cancel document edit |
|
|
Compare versions |
|
|
Help |
Configure OpenKM Add-In
OpenKM version 6.3.8
First you must select the OpenKM toolbar option to set your configuration values to access OpenKM from the client computer. If you've got other OpenKM Add-Ins already installed, this may not be needed.
Users of OpenKM version 6.3.x should use "Webservices 1.0" in the OpenKM version configuration option.
OpenKM version 6.3.9 and above
First, you must choose the Configuration menu item to set your configuration values to access OpenKM from the client computer.
| Property | Type | Description |
|---|---|---|
| Language | Select | MS Add-in user interface language. |
|
User |
String |
User ID for accessing OpenKM. okmAdmin |
|
Password |
String |
The user's password. admin |
|
Host |
String |
OpenKM URL. http://localhost:8080/OpenKM/ |
|
Add metadata |
Bool |
To enable/disable the metadata selection form. |
When you set your configuration values, a folder called OpenKM is created in your user My Documents folder. In this OpenKM folder, a configuration file called openkm.xml and another file called document.xml are created, which the OpenKM Add-in uses to store some document editing information. You should not edit or delete these files.
Uploading a new file
Click on the add new document button. A folder tree view will be shown. You must select the folder where you want to upload the file.
Click on the Send button; the document will then be uploaded to OpenKM, and a notification message will be shown.
Editing an OpenKM document
Click on the document edit button. A folder navigator will appear. You must navigate through folders and select a document that you want to edit.
When you have an OpenKM document open, the Upload modified document (check-in) and
Cancel document edit toolbar options will be enabled.
- To upload a modified document, use the
Upload modified document (check-in) toolbar button.
- To cancel document editing, use the
Cancel document edit toolbar button.
After editing, your local document copy will be deleted to prevent user errors.
Compare versions
Clicking on the "Compare versions" button will display the version history in a pop-up allowing you to select a version to compare.
You must first edit a document for the "Compare versions" button to be enabled.
The comparison is made in a new Office Word window. To return to the main document, just close this window.
Log
In My Documents/OpenKM there's a log file called WordAddin.log with a complete log trace.
