Excel Add-in
Excel 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 to upload the file.
The OpenKM Excel Add-in detects whether 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 |
|
|
Help |
Configure OpenKM Add-In
First, you must select the Configuration menu item to set your configuration values for accessing 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. https://demo.openkm.com/OpenKM/ |
|
Add metadata |
Bool |
To enable or disable the metadata selection form. |
After you set your configuration values, a folder called OpenKM is created in your user's 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 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 the Upload button; the document will then be uploaded to OpenKM and a notification message will be shown.
If you have enabled the option "Add metadata" in the configuration, it will allow you to select and fill in the corresponding data.
If you have multiple selection metadata to mark and unmark all options, you can use the key combination "Ctrl" + "E" and "Supr" respectively.
Editing an OpenKM document
Click the document edit button. A folder navigator will appear. You must navigate through folders and select the document 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.
Insert a comment for the version and press the OK button.
- To cancel document editing, use the
Cancel document edit toolbar button.
After editing, your local document copy will be deleted to prevent user mistakes.
Log
In My Documents/OpenKM there is a log file called ExcelAddin.log containing a complete log trace.
