Setup

Download

You can download the application from OpenKM Download center.

To run the application on your computer you will need Java 11 installed.

Linux configuration

Unzip the Import-station-3.x.zip file at /home/openkm/

Caution

The name of the zip file may have changed.

$ cd /home/openkm
$ unzip Import-station-3.x.zip

In the /home/openkm/import-station/  folder you will have the following content:

• WAR file of the import-station application.
• plugins folder: which contains the list of available plugins.
• import-station.cfg: configuration file.
• translations.sql: contains the translation terms of the application.

Register translations

You must register the import-station translations in your OpenKM. The application is used for storing the import-station translations.

• Go to your OpenKM at Administration > Tools > Database Query.
• Copy all the SQL contents into the text area.
• Choose the JDBC option from the bottom right.
• Click on the “Execute” button.

Configure connection

Edit the import-station.cfg file with the following values:

Property	Description
okm.url	OpenKM URL http://localhost:8080/openkm/
okm.import.plugins.directory	Path to the plugins directory /home/openkm/import-station/plugins
okm.login.token.expiration  (optional)	Token expiration time in days. By default, it has an expiration time of 24 hours.

Launch the application

To launch the application, use this command:

$ java -jar import-station.war

Note

This will deploy a web application on port 3000.

Access the application by opening the URL http://YOUR\_SERVER\_IP:3000 in a browser (for example http://localhost:3000/).

Tip

The first time you log in to the application, a file called import-station.db  will be created in the /home/openkm/import-station/ folder.

Danger

The import-station.db file is an embedded database file used by the application and contains relevant information. Do not delete it!

Launch with custom cfg file

You can launch the app with your custom config file. To do this, just set the absolute path to the configuration file as a parameter:

$ java -jar import-station.war /home/user/my-config.cfg

Application command line help

Running the application with the command help will print information about all available command-line options.

$ java -jar import-station.war help

Windows configuration

Unzip the Import-station-3.x.zip file at c:\openkm\

Caution

The name of the zip file may have changed.

In the c:\openkm\import-station\  folder you will have the following content:

• JAR file of the import-station application.
• plugins folder: which contains the list of plugins available.
• import-station.cfg: configuration file.
• translations.sql: contains the translation terms of the application.

Register translations

You must register the import-station translations in your OpenKM. The application is used for storing the import-station translations.

• Go to your OpenKM at Administration > Tools > Database Query.
• Copy all the SQL contents into the text area.
• Choose the JDBC option from the bottom right.
• Click on the “Execute” button.

Configure connection

Edit the import-station.cfg file with the following values:

Property	Description
okm.url	OpenKM URL http://localhost:8080/openkm/
okm.import.folder	OpenKM default import path. /okm:root/import By default, documents are imported to /okm:root/import
okm.import.plugins.directory	Path to the plugins directory c:/openkm/import-station/plugins
okm.login.token.expiration  (optional)	Token expiration time in days. By default, it has an expiration time of 24 hours.

Launch the application

To launch the application, use this command:

C:\> java -Dfile.encoding=UTF-8 -Dsun.jnu.encoding=UTF-8 -jar import-station.war

Note

This will deploy a web application on port 3000.

Access the application from the URL http://YOUR\_SERVER\_IP:3000 in a browser (for example http://localhost:3000/).

Tip

The first time you log in to the application, a file called import-station.db  will be created in the c:\openkm\import-station\ folder.

Danger

The import-station.db file is an embedded database file used by the application and contains relevant information. Do not delete it!

Launch with custom cfg file

You can launch the app with your custom config file. To do this, just set the absolute path to the configuration file as a parameter:

C:\> java -Dfile.encoding=UTF-8 -Dsun.jnu.encoding=UTF-8 -jar import-station.war c:/my-config.cfg

Application command line help

Running the application with the command help will print information about all available command-line options.

C:\> java -jar import-station.war help