User guide v4.x

The OKMLiveEdit tool allows you to quickly edit documents that are in the OpenKM repository.

Configuration

1. From the notification area of the taskbar, right-click the OKMLiveEdit icon and go to the “Configuration” menu.
2. This action will show a popup 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.

Alternative configuration of the main file folder

OKMLiveEdit allows you to configure a custom path for storing key application files such as:

• The log file (openkm.log)
• The configuration file (openkm.xml)
• Temporary files generated during runtime

This configuration is done using the okm.folder.path property, located in the app.properties file within the installation directory.

Example:

okm.folder.path=C:\\New_folder_path

Note

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

After making the changes, you must restart the OKMLiveEdit.

Use

Tip

It is mandatory to enable the Live Edit function in OpenKM. More information is available in the Enable extensions section of the OpenKM application documentation.

Tip

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.

1. Choose a document in the OpenKM user interface.
2. Click the Edit button. (A pop-up window titled “Launch application” will open; it is recommended to check the option “Remember my choice for liveedit links” and press the “Open link” button.)
3. 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 software. (For example, if you edit a .docx document, it will usually be opened by Microsoft Office or LibreOffice.)
4. 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 delete the file from the queue, press the Delete button.

Note

For example, when editing images, you should set the OS program for editing; otherwise, the images will be opened by the Windows Photos viewer.

Note

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

In My Documents/OpenKM, the following log files are found:

• OKMLiveEdit.log contains the full log trace. 
• OKMLiveEdit_installer.log contains information about the installation process.