Project Add-in
Project Add-in enables users to upload new files and edit existing OpenKM files.
To upload a new file, choose a destination folder from the OpenKM tree view.
The OpenKM Project 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 2003 to version 2019.
After installing the Project add-in, a new menu item "OpenKM" will appear in Project.
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 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 password of the user. admin |
|
Host |
String |
OpenKM URL. https://demo.openkm.com/OpenKM/ |
|
Add metadata |
Bool |
To enable/disable the metadata selection form. |
After you set your configuration values, a folder named OpenKM is created in your user's My Documents folder. In this OpenKM folder, a configuration file named openkm.xml and another file called document.xml are created. The OpenKM Add-in uses these files 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, and a folder tree view will be shown. You must choose the folder where you want to upload the file.
Click on the Send button, and after that the document will be uploaded to OpenKM and a notification message will be shown.
If you have activated the option "Add metadata" in the configuration, it will allow you to select and fill in the corresponding data.
In the case of metadata with multiple selection, to mark and unmark all options you can use the key combinations "Ctrl" + "E" and "Supr", respectively.
Editing an OpenKM document
Click on the document edit button, and a folder navigator will appear. You must navigate across folders and choose 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.
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's a log file named ProjectAddin.log with a complete log trace.
