Quick start

This section contains information about how to log into the application and what you will see after logging in.

 Login

Once you point your browser to http://YOUR_SERVER_IP:3000 you will see the application login page. This page is the first page shown to the user when you point your browser to the application.

You should use your Openkm login and password in order to access the application:

Tip

If the login and password are correct, you will enter the application

Danger

If the login or password are not correct, you will see an error

Note

Login credentials are stored in the import-station.cfg file (only if okm.system.user is empty). This user will be used to schedule periodic tasks after system reboot.

If you want to change this user, just leave both okm.system.user and okm.system.password properties empty.

Main page

This is the first page we see after logging into the application. The main page of the application contains a table showing every task registered in the system with its state and possible actions.

The table contains the following information:

Field	Description
Type	On-demand or scheduled
Name	Task name
State	State of the task. - Stopped: The task is not scheduled in the system and is not running either - Scheduled:  The task is scheduled in the system using a cron expression - Running:  The task is running in the system - Error: Blinking element. Indicates that there is an error during an execution
Processor	Plugin to be executed by the task. Depending on which plugins are configured, this list will vary.
Actions	List of actions to operate on this task. - Run: This action launches the task. If it’s periodic, it will be scheduled. If it’s not, it will be executed only once. - Edit: Change task properties. You can also change the plugin to execute. A user can only change task properties when a task is Stopped.  - Stop: Stop and unschedule the task (if it’s periodic). - Delete: Delete the task. A user can only delete a task when the task is Stopped.  - CSV Report: Get a report in CSV format of every execution and execution event between two dates. - View executions: View executions and execution events for each task. See the Manage task executions section

Danger

If you have any execution problem with any task, you will see this message: 

You have executions with errors. Please check them.

Note

This message is shown to indicate to the user that something went wrong and you should fix it.

Tip

There is a Refresh button on the main page. It’s used to reload the page to see current status of each task.