User guide v5.x

Hot folder tool allows the user to synchronize one or more local folders with others located in the OpenKM repository.

Configuration

1. Go to the notification area of the Windows taskbar.
2. Right-click the OKMHotFolder icon.
3. Go to the “Server configuration” and “Folder settings” options. 

Server Configuration:

First, you must choose the Server configuration menu item to set your configuration values:

Property	Type	Description
Language	Select	User interface language.
User	String	User ID for accessing OpenKM. user1
Password	String	The password of the user. pass1
Host	String	OpenKM URL. http://localhost:8080/openkm/
Use personal  token	Bool	Authentication will be done using the access token.
Personal token	String	The personal access token okmpat-Ky1t16O2Rwx4ttPmOK0R

Note

After you set your configuration values, a folder called OpenKM is created in your user’s My Documents folder. In this OpenKM folder, there is a configuration file named openkm.xml

 Folder Settings:

1. Select a folder from your local disk.
2. Select a folder from the OpenKM repository.
3. Press the “Add” button (you can also edit or delete items from the list).
4. Press the “Save” button.

Danger

The “Restart” button - requires you to accept the confirmation popup - will erase all configuration.

 Upload files to OpenKM

1. Copy & paste or drag & drop files into the configured local folder.
2. The files will be uploaded to the configured OpenKM folder and will be deleted from the local disk.
3. When the file already exists in the repository, you will be asked whether to update it.

Alternative configuration of the main file folder

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 app.

Log

In My Documents/OpenKM, there’s a log file called OKMHotFolder.log with a complete log trace.