Access Add-in 8.1.x

Access Add-in allows users to upload new files to OpenKM.

To upload a new file, choose a destination folder from the OpenKM tree view.

The OpenKM Access Add-in will be visible once a database is opened.

Caution

Office Add-ins are compatible from version 2003 to version 2021.

 After installing the Access Add-in, a new menu item “OpenKM” will be shown in Access.

Details of the features according to their icons:

Button	Action
	Add-in configuration.
	Upload a file.
	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 user’s password. admin
Host	String	OpenKM URL. http://localhost:8080/openkm/
Add metadata	Bool	To enable/disable the metadata selection form.
Find by UUID	Bool	Instead of locating a folder through the search tree to upload a file, you can do so by inserting the UUID of the destination folder.
Use personal  token	Bool	Authentication will be done using the access token.
Personal token	String	The personal access token. okmpat-Ky1t16O2Rwx4ttPmOK0R

After you set your configuration values, a folder named OpenKM is created in your user My Documents folder. In this OpenKM folder, a configuration file named openkm.xml and another file named document.xml are created. The OpenKM Add-in uses them to store some document editing information. You should not edit or delete these files.

Uploading a new file

Click on the  upload button; a folder tree view will be shown. You must select the destination folder where you want to upload the file.

Caution

You need to save your changes first.

Note

Then a message will appear; select Yes if you have saved the entire Access project.

 Now you can choose the folder where you want to upload the file.

Click on the Upload button and, after that, the document will be uploaded to OpenKM and a notification message will be shown: “File has been sent successfully”.

Tip

If the file already exists in the repository, a pop-up window will indicate this. If you want to update it, press the YES button and the file will be updated with a new version.

Log

In My Documents/OpenKM there is a log file called AccessAddin.log with a complete log trace.