User guide v1.x
The OKMLiveEdit tool allows you to quickly edit documents that are in the OpenKM repository.
Configuration
- From the system tray icon, click the OKMLiveEdit icon and go to the "Settings" menu.
- This action will show a window containing a checkbox called "Open documents manually". This will tell LiveEdit not to automatically open the files to edit, and this action can be performed when selecting a document from the list by clicking on one of them.
- The same window also contains a checkbox called "Show the comment dialog when updating a document". When disabled, clicking Update uploads the new version directly with a default comment, without asking.
Alternative configuration of the working folder
OKMLiveEdit allows you to configure a custom path for the working folder, where:
- Downloaded documents are stored while being edited
- The internal document queue state is kept
This configuration is done using the okm.folder.path property, located in the system-wide /etc/openkm-liveedit/app.properties file (created by the system administrator; it does not exist by default).
Example:
okm.folder.path=/mnt/data/openkm-liveedit
When to Use This Configuration:
This option is especially useful when there are issues using the default file paths, such as:
-
Insufficient file system permissions
-
Limited disk space or access restrictions in the default location
-
Need to separate system files from configuration and data
-
IT infrastructure policies or organization requirements
This setting only affects the working folder. It does not change the location of the log file or the user configuration file, which always remain under the user's home directory (see the Log section below).
After making the changes, you must restart OKMLiveEdit.
Use
It is mandatory to enable the Live Edit function in OpenKM. More information is available at Enable extensions.
When this extension is enabled, the actions of the Edit,
Update and
Cancel edit buttons change and will be used to edit the document in this new way.
- Choose a document in the OpenKM user interface.
- Click the
Edit icon. (Your browser will ask which application should open the liveedit:// link; it is recommended to check the option to remember this choice and confirm.)
- Now the main live edit window will be shown. This window will show a list of the documents you are editing. Based on the document type, each document is automatically opened by the corresponding application. (For example, if you edit a .docx document, it will usually be opened by LibreOffice.)
- Each time the document is saved with the editing software, the changes are updated in OpenKM to preserve the edits. Until you click the
Update button, the changes will not be accepted in the OpenKM repository; clicking it creates a new document.
If you want to cancel the edit and remove the file from the queue without uploading anything, press theCancel button.
If, for some reason, we edit a document that has already been downloaded locally but the download process has not finished or it is already in the queue,
a pop-up window will be launched through which we can decide whether to continue editing the existing local copy or
simply replace that document with the newly downloaded one.
Log
The application log is found at ~/.local/state/openkm-liveedit/logs/daemon.log (under the current user's home directory) and contains the full log trace.
